1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_XAutoTextGroup_idl__
24#define __com_sun_star_text_XAutoTextGroup_idl__
25
26#ifndef __com_sun_star_container_XNameAccess_idl__
27#include <com/sun/star/container/XNameAccess.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34#ifndef __com_sun_star_container_ElementExistException_idl__
35#include <com/sun/star/container/ElementExistException.idl>
36#endif
37
38#ifndef __com_sun_star_io_IOException_idl__
39#include <com/sun/star/io/IOException.idl>
40#endif
41
42#ifndef __com_sun_star_text_XAutoTextEntry_idl__
43#include <com/sun/star/text/XAutoTextEntry.idl>
44#endif
45
46#ifndef __com_sun_star_text_XTextRange_idl__
47#include <com/sun/star/text/XTextRange.idl>
48#endif
49
50#ifndef __com_sun_star_container_NoSuchElementException_idl__
51#include <com/sun/star/container/NoSuchElementException.idl>
52#endif
53
54
55//=============================================================================
56
57 module com {  module sun {  module star {  module text {
58
59//=============================================================================
60
61// DocMerge from xml: interface com::sun::star::text::XAutoTextGroup
62/** The interface provide methods to insert, rename and delete autotext entries from the current autotext group.
63 */
64published interface XAutoTextGroup: com::sun::star::container::XNameAccess
65{
66	//-------------------------------------------------------------------------
67
68	// DocMerge from idl: method com::sun::star::text::XAutoTextGroup::getTitles
69	/** returns the titles of all autotext entries. The order of the entries
70				corresponds to the output of the function getElementNames().
71	 */
72	sequence<string> getTitles();
73
74	//-------------------------------------------------------------------------
75
76	// DocMerge from xml: method com::sun::star::text::XAutoTextGroup::renameByName
77	/** renames an entry in the autotext group.
78
79
80
81		<p>The position of the autotext entry is not changed.
82
83		</p>
84	 */
85	void renameByName( [in] string aElementName,
86			 [in] string aNewElementName,
87			 [in] string aNewElementTitle )
88			raises( com::sun::star::lang::IllegalArgumentException,
89					com::sun::star::container::ElementExistException,
90					com::sun::star::io::IOException );
91
92	//-------------------------------------------------------------------------
93
94	// DocMerge from xml: method com::sun::star::text::XAutoTextGroup::insertNewByName
95	/** creates a new <type>AutoTextEntry</type> entry.
96	 */
97	com::sun::star::text::XAutoTextEntry insertNewByName( [in] string aName,
98			 [in] string aTitle,
99			 [in] com::sun::star::text::XTextRange xTextRange )
100			raises( com::sun::star::container::ElementExistException );
101
102	//-------------------------------------------------------------------------
103
104	// DocMerge from xml: method com::sun::star::text::XAutoTextGroup::removeByName
105	/** removes the specified autotext entry.
106	 */
107	void removeByName( [in] string aEntryName )
108			raises( com::sun::star::container::NoSuchElementException );
109
110};
111
112//=============================================================================
113
114}; }; }; };
115
116
117#endif
118