LibreOffice LibreOffice 25.8 SDK API Reference

XSmartTagAction.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
21module com { module sun { module star { module smarttags {
22
23
29 interface XSmartTagAction: com::sun::star::lang::XInitialization
30{
39 string getName( [in] ::com::sun::star::lang::Locale aLocale );
40
41
50 string getDescription( [in] ::com::sun::star::lang::Locale aLocale );
51
52
56 [attribute, readonly] long SmartTagCount;
57
58
74 string getSmartTagName( [in] long nSmartTagIndex)
75 raises( com::sun::star::lang::IndexOutOfBoundsException );
76
77
95 string getSmartTagCaption( [in] long nSmartTagIndex,
96 [in] ::com::sun::star::lang::Locale aLocale)
97 raises( com::sun::star::lang::IndexOutOfBoundsException );
98
99
118 long getActionCount( [in] string aSmartTagName,
119 [in] com::sun::star::frame::XController xController,
120 [in] com::sun::star::container::XStringKeyMap xProperties);
121
141 long getActionID( [in] string aSmartTagName, [in] long nActionIndex,
142 [in] com::sun::star::frame::XController xController )
143 raises( com::sun::star::lang::IllegalArgumentException );
144
145
181 string getActionCaptionFromID( [in] long nActionID,
182 [in] string aApplicationName,
183 [in] ::com::sun::star::lang::Locale aLocale,
184 [in] com::sun::star::container::XStringKeyMap xProperties,
185 [in] string aText,
186 [in] string aXML,
187 [in] com::sun::star::frame::XController xController,
188 [in] com::sun::star::text::XTextRange xTarget )
189 raises( com::sun::star::lang::IllegalArgumentException );
190
191
206 string getActionNameFromID( [in] long nActionID,
207 [in] com::sun::star::frame::XController xController)
208 raises( com::sun::star::lang::IllegalArgumentException );
209
210
242 void invokeAction( [in] long nActionID,
243 [in] string aApplicationName,
244 [in] com::sun::star::frame::XController xController,
245 [in] com::sun::star::text::XTextRange xTarget,
246 [in] com::sun::star::container::XStringKeyMap xProperties,
247 [in] string aText,
248 [in] string aXML,
249 [in] ::com::sun::star::lang::Locale aLocale )
250 raises( com::sun::star::lang::IllegalArgumentException );
251
252
273 boolean isCaptionDynamic( [in] long nActionID,
274 [in] string aApplicationName,
275 [in] com::sun::star::frame::XController xController,
276 [in] ::com::sun::star::lang::Locale aLocale )
277 raises( com::sun::star::lang::IllegalArgumentException );
278
279
301 boolean isShowSmartTagIndicator( [in] long nActionID,
302 [in] string aApplicationName,
303 [in] com::sun::star::frame::XController xController,
304 [in] ::com::sun::star::lang::Locale aLocale )
305 raises( com::sun::star::lang::IllegalArgumentException );
306};
307
308}; }; }; };
309
310/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::lang::IndexOutOfBoundsException
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:31
com::sun::star::container::XStringKeyMap
maps strings to anys.
Definition: XStringKeyMap.idl:30
com::sun::star::frame::XController
With this interface, components viewed in a Frame can serve events (by supplying dispatches).
Definition: XController.idl:34
com::sun::star::lang::XInitialization
initializes an object directly after its creation.
Definition: XInitialization.idl:41
com::sun::star::smarttags::XSmartTagAction
provides access to smart tag actions.
Definition: XSmartTagAction.idl:30
com::sun::star::smarttags::XSmartTagAction::invokeAction
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)
invokes an action.
com::sun::star::smarttags::XSmartTagAction::getActionCaptionFromID
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)
obtains a caption for a specified action for use in user interfaces.
com::sun::star::smarttags::XSmartTagAction::getActionNameFromID
string getActionNameFromID([in] long nActionID, [in] com::sun::star::frame::XController xController)
obtains a language independent name of an action.
com::sun::star::smarttags::XSmartTagAction::getSmartTagName
string getSmartTagName([in] long nSmartTagIndex)
obtains the name of one specific smart tag type supported by this action component.
com::sun::star::smarttags::XSmartTagAction::isCaptionDynamic
boolean isCaptionDynamic([in] long nActionID, [in] string aApplicationName, [in] com::sun::star::frame::XController xController, [in] ::com::sun::star::lang::Locale aLocale)
determines whether a caption is dynamic.
com::sun::star::smarttags::XSmartTagAction::getActionID
long getActionID([in] string aSmartTagName, [in] long nActionIndex, [in] com::sun::star::frame::XController xController)
obtains a unique integer identifier for an action.
com::sun::star::smarttags::XSmartTagAction::getActionCount
long getActionCount([in] string aSmartTagName, [in] com::sun::star::frame::XController xController, [in] com::sun::star::container::XStringKeyMap xProperties)
obtains the number of actions provided for a specified smart tag type.
com::sun::star::smarttags::XSmartTagAction::getDescription
string getDescription([in] ::com::sun::star::lang::Locale aLocale)
obtains a detailed description of this action component.
com::sun::star::smarttags::XSmartTagAction::getSmartTagCaption
string getSmartTagCaption([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale)
obtains the caption of the smart tag type for using in user interfaces.
com::sun::star::smarttags::XSmartTagAction::isShowSmartTagIndicator
boolean isShowSmartTagIndicator([in] long nActionID, [in] string aApplicationName, [in] com::sun::star::frame::XController xController, [in] ::com::sun::star::lang::Locale aLocale)
determines whether the smart tag indicator should be visible.
com::sun::star::smarttags::XSmartTagAction::getName
string getName([in] ::com::sun::star::lang::Locale aLocale)
obtains a name that describes this action component.
com::sun::star::smarttags::XSmartTagAction::SmartTagCount
long SmartTagCount
the number of smart tag types supported by this action component.
Definition: XSmartTagAction.idl:56
com::sun::star::text::XTextRange
describes the object's position in a text.
Definition: XTextRange.idl:34
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34