LibreOffice
LibreOffice 7.4 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 #ifndef __com_sun_star_smarttags_XSmartTagAction_idl__
21 #define __com_sun_star_smarttags_XSmartTagAction_idl__
22 
30 
31 
32 module com { module sun { module star { module smarttags {
33 
34 
41 {
50  string getName( [in] ::com::sun::star::lang::Locale aLocale );
51 
52 
61  string getDescription( [in] ::com::sun::star::lang::Locale aLocale );
62 
63 
67  [attribute, readonly] long SmartTagCount;
68 
69 
85  string getSmartTagName( [in] long nSmartTagIndex)
87 
88 
106  string getSmartTagCaption( [in] long nSmartTagIndex,
107  [in] ::com::sun::star::lang::Locale aLocale)
109 
110 
129  long getActionCount( [in] string aSmartTagName,
130  [in] com::sun::star::frame::XController xController,
132 
152  long getActionID( [in] string aSmartTagName, [in] long nActionIndex,
153  [in] com::sun::star::frame::XController xController )
155 
156 
192  string getActionCaptionFromID( [in] long nActionID,
193  [in] string aApplicationName,
194  [in] ::com::sun::star::lang::Locale aLocale,
196  [in] string aText,
197  [in] string aXML,
198  [in] com::sun::star::frame::XController xController,
199  [in] com::sun::star::text::XTextRange xTarget )
201 
202 
217  string getActionNameFromID( [in] long nActionID,
218  [in] com::sun::star::frame::XController xController)
220 
221 
253  void invokeAction( [in] long nActionID,
254  [in] string aApplicationName,
255  [in] com::sun::star::frame::XController xController,
258  [in] string aText,
259  [in] string aXML,
260  [in] ::com::sun::star::lang::Locale aLocale )
262 
263 
284  boolean isCaptionDynamic( [in] long nActionID,
285  [in] string aApplicationName,
286  [in] com::sun::star::frame::XController xController,
287  [in] ::com::sun::star::lang::Locale aLocale )
289 
290 
312  boolean isShowSmartTagIndicator( [in] long nActionID,
313  [in] string aApplicationName,
314  [in] com::sun::star::frame::XController xController,
315  [in] ::com::sun::star::lang::Locale aLocale )
317 };
318 
319 }; }; }; };
320 
321 #endif
322 
323 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
This exception is thrown to indicate that a container has been accessed with an illegal index.
Definition: IndexOutOfBoundsException.idl:35
maps strings to anys.
Definition: XStringKeyMap.idl:39
With this interface, components viewed in a Frame can serve events (by supplying dispatches).
Definition: XController.idl:38
initializes an object directly after its creation.
Definition: XInitialization.idl:47
provides access to smart tag actions.
Definition: XSmartTagAction.idl:41
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.
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.
string getActionNameFromID([in] long nActionID, [in] com::sun::star::frame::XController xController)
obtains a language independent name of an action.
string getSmartTagName([in] long nSmartTagIndex)
obtains the name of one specific smart tag type supported by this action component.
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.
long getActionID([in] string aSmartTagName, [in] long nActionIndex, [in] com::sun::star::frame::XController xController)
obtains a unique integer identifier for an action.
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.
string getDescription([in] ::com::sun::star::lang::Locale aLocale)
obtains a detailed description of this action component.
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.
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.
string getName([in] ::com::sun::star::lang::Locale aLocale)
obtains a name that describes this action component.
long SmartTagCount
the number of smart tag types supported by this action component.
Definition: XSmartTagAction.idl:67
describes the object's position in a text.
Definition: XTextRange.idl:38
Definition: Ambiguous.idl:22
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:38