LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | Public Attributes | List of all members
XSmartTagRecognizer Interface Reference

provides access to a smart tag recognizer. More...

import"XSmartTagRecognizer.idl";

Inheritance diagram for XSmartTagRecognizer:
XInitialization XInterface SmartTagRecognizer

Public Member Functions

string getName ([in] ::com::sun::star::lang::Locale aLocale)
 obtains a name that describes this recognizer component. More...
 
string getDescription ([in] ::com::sun::star::lang::Locale aLocale)
 obtains a detailed description of this recognizer component. More...
 
string getSmartTagName ([in] long nSmartTagIndex) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 obtains the name of one specific smart tag type supported by this recognizer component. More...
 
string getSmartTagDownloadURL ([in] long nSmartTagIndex) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 obtains the URL that can be used to download new or updated recognizers. More...
 
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. More...
 
boolean hasPropertyPage ([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 indicates whether there is a property page for a smart tag type. More...
 
void displayPropertyPage ([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. More...
 
- Public Member Functions inherited from XInitialization
void initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 initializes the object. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Public Attributes

long SmartTagCount
 The number of smart tag types supported by this recognizer component. More...
 

Detailed Description

provides access to a smart tag recognizer.

Since
OOo 2.3

Member Function Documentation

◆ displayPropertyPage()

void displayPropertyPage ( [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.

Parameters
nSmartTagIndexIndex of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively).
aLocaleIs used for localization of the property page.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif nSmartTagIndex is greater than SmartTagCount

◆ getDescription()

string getDescription ( [in] ::com::sun::star::lang::Locale  aLocale)

obtains a detailed description of this recognizer component.

Parameters
aLocaleIs used for localization of the description.
Returns
the description of the recognizer component.

◆ getName()

string getName ( [in] ::com::sun::star::lang::Locale  aLocale)

obtains a name that describes this recognizer component.

Parameters
aLocaleIs used for localization of the name.
Returns
the name of the recognizer component.

◆ getSmartTagDownloadURL()

string getSmartTagDownloadURL ( [in] long  nSmartTagIndex)
raises (com::sun::star::lang::IndexOutOfBoundsException
)

obtains the URL that can be used to download new or updated recognizers.

Parameters
nSmartTagIndexIndex of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively).
Returns
the download URL.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif nSmartTagIndex is greater than SmartTagCount

◆ getSmartTagName()

string getSmartTagName ( [in] long  nSmartTagIndex)
raises (com::sun::star::lang::IndexOutOfBoundsException
)

obtains the name of one specific smart tag type supported by this recognizer component.

Parameters
nSmartTagIndexIndex of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively).
Returns
the unique name of the smart tag type. Smart tag type names are always in the format of namespaceURI::tagname.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif nSmartTagIndex is greater than SmartTagCount

◆ hasPropertyPage()

boolean hasPropertyPage ( [in] long  nSmartTagIndex,
[in] ::com::sun::star::lang::Locale  aLocale 
)
raises (com::sun::star::lang::IndexOutOfBoundsException
)

indicates whether there is a property page for a smart tag type.

Parameters
nSmartTagIndexIndex of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively).
aLocaleIs used for localization of the property page.
Returns
true if there is a property page matching the requested smart tag type and locale.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif nSmartTagIndex is greater than SmartTagCount

◆ 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 
)

recognizes smart tags.

Parameters
aTextThe text that should be scanned by the recognizer. aText is UTF-16 encoded.
nStartDenotes the start position of the region to scan.
nLengthDenotes the length of the text to scan.
eDataTypeThis value indicates the type of the passed text.
aLocaleIs used to indicate the language of the passed text.
xTextMarkupThis object is used to submit any recognized smart tags to the calling application.
aApplicationNameA string containing the name of the calling application.
xControllerThe current controller of the document.
xTokenizerThis can be used to tokenize the string to recognize.

Member Data Documentation

◆ SmartTagCount

long SmartTagCount
attributereadonly

The number of smart tag types supported by this recognizer component.


The documentation for this interface was generated from the following file: