1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XDocumentTemplates.idl,v $
* $Revision: 1.8 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_frame_XDocumentTemplates_idl__
#define __com_sun_star_frame_XDocumentTemplates_idl__
#ifndef __com_sun_star_frame_XStorable_idl__
#include <com/sun/star/frame/XStorable.idl>
#endif
#ifndef __com_sun_star_ucb_XContent_idl__
#include <com/sun/star/ucb/XContent.idl>
#endif
//=============================================================================
module com { module sun { module star { module frame {
//=============================================================================
/** provides a high level api to organize document templates
<p>
Template informations are saved as links to the original content
and organized in groups. This data should be persistent and can be
updated by calling special method <member>XDocumentTemplates::update()</member>.
A real implementation of this interface can do that on top of
an ucb content provider. Method <member>XDocumentTemplates::getContent()</member>
force that.
</p>
*/
published interface XDocumentTemplates: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** privides access to the root of internal used hierarchy
<p>
This content can be used for accessing the groups directly.
</p>
@return
the ucb content for template configuration
*/
com::sun::star::ucb::XContent getContent();
//-------------------------------------------------------------------------
/** creates the template with the given name in the given group using the
data from the storable
@param GroupName
specifies the group
@param TemplateName
specifies the template
@param Storable
specifies the target
@return
<TRUE/> if operation was sucessfully
<br>
<FALSE/> otherwise
@see XDocumentTemplates::addTemplate()
*/
boolean storeTemplate(
[in] string GroupName,
[in] string TemplateName,
[in] XStorable Storable);
//-------------------------------------------------------------------------
/** creates the template with the given name in the given group using the
given URL
@param GroupName
specifies the group
@param TemplateName
specifies the template
@param SourceURL
specifies the position of template
@return
<TRUE/> if operation was sucessfully
<br>
<FALSE/> otherwise
@see XDocumentTemplates::storeTemplate()
*/
boolean addTemplate(
[in] string GroupName,
[in] string TemplateName,
[in] string SourceURL);
//-------------------------------------------------------------------------
/** remove a template from specified group
@param GroupName
specifies the group which include the template
@param TemplateName
specifies the template for delete
@return
<TRUE/> if operation was sucessfully
<br>
<FALSE/> otherwise
*/
boolean removeTemplate(
[in] string GroupName,
[in] string TemplateName);
//-------------------------------------------------------------------------
/** rename a template inside specified group
@param GroupName
specifies the group which include the template
@param TemplateName
specifies the template for renaming
@return
<TRUE/> if operation was sucessfully
<br>
<FALSE/> otherwise
*/
boolean renameTemplate(
[in] string GroupName,
[in] string OldTemplateName,
[in] string NewTemplateName);
//-------------------------------------------------------------------------
/** creates a new group
@param GroupName
the name of the group to be created
@return
<TRUE/> if operation was sucessfully
<br>
<FALSE/> otherwise
*/
boolean addGroup( [in] string GroupName );
//-------------------------------------------------------------------------
/** remove an existing group
@param GroupName
the name of the group to be removed
@return
<TRUE/> if operation was sucessfully
<br>
<FALSE/> otherwise
*/
boolean removeGroup( [in] string GroupName );
//-------------------------------------------------------------------------
/** rename an existing group
@param OldGroupName
the old name of the group
@param NewGroupName
the new name of the group
@return
<TRUE/> if operation was sucessfully
<br>
<FALSE/> otherwise
*/
boolean renameGroup(
[in] string OldGroupName,
[in] string NewGroupName);
//-------------------------------------------------------------------------
/** force an update for internal structures
<p>
Because the templates are well known by links and not as direct content
they can be outdated. An update force actualization of that to find
wrong links.
</p>
*/
[oneway] void update();
};
//=============================================================================
}; }; }; };
#endif
|
