LibreOffice LibreOffice 25.2 SDK API Reference

XAutoTextGroup.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21
22 module com { module sun { module star { module text {
23
26published interface XAutoTextGroup: com::sun::star::container::XNameAccess
27{
31 sequence<string> getTitles();
32
41 void renameByName( [in] string aElementName,
42 [in] string aNewElementName,
43 [in] string aNewElementTitle )
44 raises( com::sun::star::lang::IllegalArgumentException,
45 com::sun::star::container::ElementExistException,
46 com::sun::star::io::IOException );
47
50 com::sun::star::text::XAutoTextEntry insertNewByName( [in] string aName,
51 [in] string aTitle,
52 [in] com::sun::star::text::XTextRange xTextRange )
53 raises( com::sun::star::container::ElementExistException );
54
57 void removeByName( [in] string aEntryName )
58 raises( com::sun::star::container::NoSuchElementException );
59
60};
61
62
63}; }; }; };
64
65
66/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:35
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::container::XNameAccess
is used to access named objects within a container.
Definition: XNameAccess.idl:32
com::sun::star::text::XAutoTextEntry
identifies an autotext entry.
Definition: XAutoTextEntry.idl:41
com::sun::star::text::XAutoTextGroup
The interface provide methods to insert, rename and delete autotext entries from the current autotext...
Definition: XAutoTextGroup.idl:27
com::sun::star::text::XAutoTextGroup::renameByName
void renameByName([in] string aElementName, [in] string aNewElementName, [in] string aNewElementTitle)
renames an entry in the autotext group.
com::sun::star::text::XAutoTextGroup::getTitles
sequence< string > getTitles()
returns the titles of all autotext entries.
com::sun::star::text::XAutoTextGroup::insertNewByName
com::sun::star::text::XAutoTextEntry insertNewByName([in] string aName, [in] string aTitle, [in] com::sun::star::text::XTextRange xTextRange)
creates a new AutoTextEntry entry.
com::sun::star::text::XAutoTextGroup::removeByName
void removeByName([in] string aEntryName)
removes the specified autotext entry.
com::sun::star::text::XTextRange
describes the object's position in a text.
Definition: XTextRange.idl:34
com
Definition: Ambiguous.idl:20