LibreOffice: com/sun/star/smarttags/XSmartTagRecognizer.idl Source File

LibreOffice LibreOffice 7.3 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
23#include <com/sun/star/lang/XInitialization.idl>
24#include <com/sun/star/lang/Locale.idl>
25#include <com/sun/star/i18n/XBreakIterator.idl>
26#include <com/sun/star/smarttags/SmartTagRecognizerMode.idl>
27#include <com/sun/star/text/XTextMarkup.idl>
28#include <com/sun/star/text/XTextRange.idl>
29#include <com/sun/star/frame/XController.idl>
30#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
31
32module com { module sun { module star { module smarttags {
33
34
41 interface XSmartTagRecognizer: com::sun::star::lang::XInitialization
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 )
87 raises( com::sun::star::lang::IndexOutOfBoundsException );
88
89
104 string getSmartTagDownloadURL( [in] long nSmartTagIndex )
105 raises( com::sun::star::lang::IndexOutOfBoundsException );
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 )
168 raises( com::sun::star::lang::IndexOutOfBoundsException );
169
170
184 void displayPropertyPage( [in] long nSmartTagIndex,
185 [in] ::com::sun::star::lang::Locale aLocale )
186 raises( com::sun::star::lang::IndexOutOfBoundsException );
187
188};
189
190}; }; }; };
191
192#endif
193
194/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IndexOutOfBoundsException.idl
Locale.idl
SmartTagRecognizerMode.idl
XBreakIterator.idl
XController.idl
XInitialization.idl
XTextMarkup.idl
XTextRange.idl
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
com::sun::star::frame::XController
With this interface, components viewed in a Frame can serve events (by supplying dispatches).
Definition: XController.idl:38
com::sun::star::i18n::XBreakIterator
contains the base routines for iteration in Unicode string.
Definition: XBreakIterator.idl:40
com::sun::star::lang::XInitialization
initializes an object directly after its creation.
Definition: XInitialization.idl:47
com::sun::star::smarttags::XSmartTagRecognizer
provides access to a smart tag recognizer.
Definition: XSmartTagRecognizer.idl:42
com::sun::star::smarttags::XSmartTagRecognizer::getSmartTagName
string getSmartTagName([in] long nSmartTagIndex)
obtains the name of one specific smart tag type supported by this recognizer component.
com::sun::star::smarttags::XSmartTagRecognizer::getSmartTagDownloadURL
string getSmartTagDownloadURL([in] long nSmartTagIndex)
obtains the URL that can be used to download new or updated recognizers.
com::sun::star::smarttags::XSmartTagRecognizer::getDescription
string getDescription([in] ::com::sun::star::lang::Locale aLocale)
obtains a detailed description of this recognizer component.
com::sun::star::smarttags::XSmartTagRecognizer::displayPropertyPage
void displayPropertyPage([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale)
launches the property page for a smart tag type.
com::sun::star::smarttags::XSmartTagRecognizer::getName
string getName([in] ::com::sun::star::lang::Locale aLocale)
obtains a name that describes this recognizer component.
com::sun::star::smarttags::XSmartTagRecognizer::SmartTagCount
long SmartTagCount
The number of smart tag types supported by this recognizer component.
Definition: XSmartTagRecognizer.idl:68
com::sun::star::smarttags::XSmartTagRecognizer::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.
com::sun::star::smarttags::XSmartTagRecognizer::hasPropertyPage
boolean hasPropertyPage([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale)
indicates whether there is a property page for a smart tag type.
com::sun::star::text::XTextMarkup
provides functionality to markup text.
Definition: XTextMarkup.idl:37
com::sun::star::smarttags::SmartTagRecognizerMode
SmartTagRecognizerMode
specifies the which type of text is passed to XSmartTagRecognizer::recognize()
Definition: SmartTagRecognizerMode.idl:34
com
Definition: Accessible.idl:22
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:38