LibreOffice
LibreOffice 7.4 SDK API Reference
XSmartTagRecognizer.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 #ifndef __com_sun_star_smarttags_XSmartTagRecognizer_idl__
21 #define __com_sun_star_smarttags_XSmartTagRecognizer_idl__
22 
31 
32 module com { module sun { module star { module smarttags {
33 
34 
42 {
51  string getName( [in] ::com::sun::star::lang::Locale aLocale );
52 
53 
62  string getDescription( [in] ::com::sun::star::lang::Locale aLocale );
63 
64 
68  [attribute, readonly] long SmartTagCount;
69 
70 
86  string getSmartTagName( [in] long nSmartTagIndex )
88 
89 
104  string getSmartTagDownloadURL( [in] long nSmartTagIndex )
106 
107 
139  void recognize( [in] string aText,
140  [in] long nStart,
141  [in] long nLength,
142  [in] SmartTagRecognizerMode eDataType,
143  [in] com::sun::star::lang::Locale aLocale,
144  [in] com::sun::star::text::XTextMarkup xTextMarkup,
145  [in] string aApplicationName,
146  [in] com::sun::star::frame::XController xController,
147  [in] com::sun::star::i18n::XBreakIterator xTokenizer );
148 
166  boolean hasPropertyPage( [in] long nSmartTagIndex,
167  [in] ::com::sun::star::lang::Locale aLocale )
169 
170 
184  void displayPropertyPage( [in] long nSmartTagIndex,
185  [in] ::com::sun::star::lang::Locale aLocale )
187 
188 };
189 
190 }; }; }; };
191 
192 #endif
193 
194 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
With this interface, components viewed in a Frame can serve events (by supplying dispatches).
Definition: XController.idl:38
contains the base routines for iteration in Unicode string.
Definition: XBreakIterator.idl:40
initializes an object directly after its creation.
Definition: XInitialization.idl:47
provides access to a smart tag recognizer.
Definition: XSmartTagRecognizer.idl:42
string getSmartTagName([in] long nSmartTagIndex)
obtains the name of one specific smart tag type supported by this recognizer component.
string getSmartTagDownloadURL([in] long nSmartTagIndex)
obtains the URL that can be used to download new or updated recognizers.
string getDescription([in] ::com::sun::star::lang::Locale aLocale)
obtains a detailed description of this recognizer component.
void displayPropertyPage([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale)
launches the property page for a smart tag type.
string getName([in] ::com::sun::star::lang::Locale aLocale)
obtains a name that describes this recognizer component.
long SmartTagCount
The number of smart tag types supported by this recognizer component.
Definition: XSmartTagRecognizer.idl:68
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)
recognizes smart tags.
boolean hasPropertyPage([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale)
indicates whether there is a property page for a smart tag type.
provides functionality to markup text.
Definition: XTextMarkup.idl:37
SmartTagRecognizerMode
specifies the which type of text is passed to XSmartTagRecognizer::recognize()
Definition: SmartTagRecognizerMode.idl:34
Definition: Ambiguous.idl:22
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:38