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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_smarttags_XSmartTagRecognizer_idl__
#define __com_sun_star_smarttags_XSmartTagRecognizer_idl__
#ifndef __com_sun_star_uno_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
#ifndef __com_sun_star_i18n_XBreakIterator_idl__
#include <com/sun/star/i18n/XBreakIterator.idl>
#endif
#ifndef __com_sun_star_smarttags_SmartTagRecognizerMode_idl__
#include <com/sun/star/smarttags/SmartTagRecognizerMode.idl>
#endif
#ifndef __com_sun_star_text_XTextMarkup_idl__
#include <com/sun/star/text/XTextMarkup.idl>
#endif
#ifndef __com_sun_star_frame_XController_idl__
#include <com/sun/star/frame/XController.idl>
#endif
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif
//=============================================================================
module com { module sun { module star { module smarttags {
//=============================================================================
/**
provides access to a smart tag recognizer.
@since OOo 2.3
*/
interface XSmartTagRecognizer: com::sun::star::lang::XInitialization
{
//-------------------------------------------------------------------------
/** obtains a name that describes this recognizer component.
@param aLocale
Is used for localization of the name.
@return
the name of the recognizer component.
*/
string getName( [in] ::com::sun::star::lang::Locale aLocale );
//-------------------------------------------------------------------------
/** obtains a detailed description of this recognizer component.
@param aLocale
Is used for localization of the description.
@return
the description of the recognizer component.
*/
string getDescription( [in] ::com::sun::star::lang::Locale aLocale );
//-------------------------------------------------------------------------
/** The number of smart tag types supported by this recognizer
component.
*/
[attribute, readonly] long SmartTagCount;
//-------------------------------------------------------------------------
/** obtains the name of one specific smart tag type supported by
this recognizer component.
@param nSmartTagIndex
Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
@return
the 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 URL that can be used to download new or updated
recognizers.
@param nSmartTagIndex
Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
@return
the download URL.
@throws com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
*/
string getSmartTagDownloadURL( [in] long nSmartTagIndex )
raises( com::sun::star::lang::IndexOutOfBoundsException );
//-------------------------------------------------------------------------
/** recognizes smart tags.
@param aText
The text that should be scanned by the recognizer. aText
is UFT16 encoded.
@param nStart
Denotes the start position of the region to scan.
@param nLength
Denotes the length of the text to scan.
@param eDataType
This value indicates the type of the passed text.
@param aLocale
Is used to indicate the language of the passed text.
@param xTextMarkup
This object is used to submit any recognized smart tags
to the calling application.
@param aApplicationName
A string containing the name of the calling application.
@param xController
The current controller of the document.
@param xTokenizer
This can be used to tokenize the string to recognize.
*/
void recognize( [in] string aText,
[in] long nStart,
[in] long nLength,
[in] SmartTagRecognizerMode eDataType,
[in] com::sun::star::lang::Locale aLocale,
[in] com::sun::star::text::XTextMarkup xTextMarkup,
[in] string aApplicationName,
[in] com::sun::star::frame::XController xController,
[in] com::sun::star::i18n::XBreakIterator xTokenizer );
//-------------------------------------------------------------------------
/** indicates whether there is a property page for a smart tag type.
@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 property page.
@return
true if there is a property page matching the requested
smart tag type and locale.
@throws com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
*/
boolean hasPropertyPage( [in] long nSmartTagIndex,
[in] ::com::sun::star::lang::Locale aLocale )
raises( com::sun::star::lang::IndexOutOfBoundsException );
//-------------------------------------------------------------------------
/** launches the property page for a smart tag type.
@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 property page.
@throws com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
*/
void displayPropertyPage( [in] long nSmartTagIndex,
[in] ::com::sun::star::lang::Locale aLocale )
raises( com::sun::star::lang::IndexOutOfBoundsException );
};
}; }; }; };
#endif
|
