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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module smarttags {
/** provides access to smart tag actions.
@since OOo 2.3
*/
interface XSmartTagAction: com::sun::star::lang::XInitialization
{
/** obtains a name that describes this action component.
@param aLocale
Is used for localization of the name.
@return
the name describing the action component.
*/
string getName( [in] ::com::sun::star::lang::Locale aLocale );
/** obtains a detailed description of this action component.
@param aLocale
Is used for localization of the description.
@return
the description of the action component.
*/
string getDescription( [in] ::com::sun::star::lang::Locale aLocale );
/** the number of smart tag types supported by this action
component.
*/
[attribute, readonly] long SmartTagCount;
/** obtains the name of one specific smart tag type supported by
this action component.
@param nSmartTagIndex
Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
@return
a unique name of the smart tag type. Smart tag type
names are always in the format of namespaceURI#tagname.
@throws com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount.
*/
string getSmartTagName( [in] long nSmartTagIndex)
raises( com::sun::star::lang::IndexOutOfBoundsException );
/** obtains the caption of the smart tag type for using in user
interfaces.
@param nSmartTagIndex
Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
@param aLocale
Is used for localization of the caption.
@return
the caption associated with the smart tag type.
@throws com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
*/
string getSmartTagCaption( [in] long nSmartTagIndex,
[in] ::com::sun::star::lang::Locale aLocale)
raises( com::sun::star::lang::IndexOutOfBoundsException );
/** obtains the number of actions provided for a specified smart tag
type.
@param aSmartTagName
Name of the wanted smart tag type. This is one of the
names obtained by getSmartTagName()
@param xController
The current controller of the document.
@param xProperties
Contains the smart tag properties collected by the smart
tag recognizer.
@return
the number of actions available for the given smart tag
type.
*/
long getActionCount( [in] string aSmartTagName,
[in] com::sun::star::frame::XController xController,
[in] com::sun::star::container::XStringKeyMap xProperties);
/** obtains a unique integer identifier for an action.
@param aSmartTagName
Name of the wanted smart tag type. This is one of the
names obtained by getSmartTagName()
@param nActionIndex
The index of the action for the given smart tag type.
@param xController
The current controller of the document.
@return
the unique integer identifier for the requested action.
@throws com::sun::star::lang::IllegalArgumentException
if the specified nActionIndex is greater than the number
of available actions for the specified smart tag type.
*/
long getActionID( [in] string aSmartTagName, [in] long nActionIndex,
[in] com::sun::star::frame::XController xController )
raises( com::sun::star::lang::IllegalArgumentException );
/** obtains a caption for a specified action for use in user
interfaces.
@param nActionID
The identifier of the requested action.
@param aApplicationName
A string containing the name of the calling application.
@param aLocale
Is used for localization of the caption.
@param xProperties
Contains additional smart tag properties collected by
the smart tag recognizer.
@param aText
The calling application can pass the text of the smart
tag to the action component.
@param aXML
A string that is a XML representation of the smart tag.
@param xController
The current controller of the document.
@param xTarget
A text range representing the smart tag in the document.
@return
the caption of the requested action.
@throws com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
*/
string getActionCaptionFromID( [in] long nActionID,
[in] string aApplicationName,
[in] ::com::sun::star::lang::Locale aLocale,
[in] com::sun::star::container::XStringKeyMap xProperties,
[in] string aText,
[in] string aXML,
[in] com::sun::star::frame::XController xController,
[in] com::sun::star::text::XTextRange xTarget )
raises( com::sun::star::lang::IllegalArgumentException );
/** obtains a language independent name of an action.
@param nActionID
The identifier of the requested action.
@param xController
The current controller of the document.
@return
the language independent name of the specified action.
@throws com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
*/
string getActionNameFromID( [in] long nActionID,
[in] com::sun::star::frame::XController xController)
raises( com::sun::star::lang::IllegalArgumentException );
/** invokes an action.
@param nActionID
The identifier of the requested action.
@param aApplicationName
A string containing the name of the calling application.
@param xController
The current controller of the document.
@param xTarget
A text range representing the smart tag in the document.
@param xProperties
Contains the smart tag properties collected by the smart
tag recognizer.
@param aText
The calling application can pass the text of the smart
tag to the action component.
@param aXML
A string that is a XML representation of the smart tag.
@param aLocale
Is used for localization of the action.
@throws com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
*/
void invokeAction( [in] long nActionID,
[in] string aApplicationName,
[in] com::sun::star::frame::XController xController,
[in] com::sun::star::text::XTextRange xTarget,
[in] com::sun::star::container::XStringKeyMap xProperties,
[in] string aText,
[in] string aXML,
[in] ::com::sun::star::lang::Locale aLocale )
raises( com::sun::star::lang::IllegalArgumentException );
/** determines whether a caption is dynamic.
@param nActionID
The identifier of the requested action.
@param aApplicationName
A string containing the name of the calling application.
@param xController
The current controller of the document.
@param aLocale
Is used for localization.
@return
a boolean indicating whether the caption is dynamic.
@throws com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
*/
boolean isCaptionDynamic( [in] long nActionID,
[in] string aApplicationName,
[in] com::sun::star::frame::XController xController,
[in] ::com::sun::star::lang::Locale aLocale )
raises( com::sun::star::lang::IllegalArgumentException );
/** determines whether the smart tag indicator should be visible.
@param nActionID
The identifier of the requested action.
@param aApplicationName
A string containing the name of the calling application.
@param xController
The current controller of the document.
@param aLocale
Is used for localization.
@return
a boolean indicating whether the smart tag indicator
should be visible.
@throws com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
*/
boolean isShowSmartTagIndicator( [in] long nActionID,
[in] string aApplicationName,
[in] com::sun::star::frame::XController xController,
[in] ::com::sun::star::lang::Locale aLocale )
raises( com::sun::star::lang::IllegalArgumentException );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
