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

provides access to smart tag actions. More...

import"XSmartTagAction.idl";

Inheritance diagram for XSmartTagAction:
XInitialization XInterface SmartTagAction

Public Member Functions

string getName ([in] ::com::sun::star::lang::Locale aLocale)
 obtains a name that describes this action component. More...
 
string getDescription ([in] ::com::sun::star::lang::Locale aLocale)
 obtains a detailed description of this action 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 action component. More...
 
string getSmartTagCaption ([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 obtains the caption of the smart tag type for using in user interfaces. More...
 
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. More...
 
long getActionID ([in] string aSmartTagName, [in] long nActionIndex, [in] com::sun::star::frame::XController xController) raises ( com::sun::star::lang::IllegalArgumentException )
 obtains a unique integer identifier for an action. More...
 
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) raises ( com::sun::star::lang::IllegalArgumentException )
 obtains a caption for a specified action for use in user interfaces. More...
 
string getActionNameFromID ([in] long nActionID, [in] com::sun::star::frame::XController xController) raises ( com::sun::star::lang::IllegalArgumentException )
 obtains a language independent name of an action. More...
 
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) raises ( com::sun::star::lang::IllegalArgumentException )
 invokes an action. More...
 
boolean isCaptionDynamic ([in] long nActionID, [in] string aApplicationName, [in] com::sun::star::frame::XController xController, [in] ::com::sun::star::lang::Locale aLocale) raises ( com::sun::star::lang::IllegalArgumentException )
 determines whether a caption is dynamic. More...
 
boolean isShowSmartTagIndicator ([in] long nActionID, [in] string aApplicationName, [in] com::sun::star::frame::XController xController, [in] ::com::sun::star::lang::Locale aLocale) raises ( com::sun::star::lang::IllegalArgumentException )
 determines whether the smart tag indicator should be visible. 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 action component. More...
 

Detailed Description

provides access to smart tag actions.

Since
OOo 2.3

Member Function Documentation

◆ 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 
)
raises (com::sun::star::lang::IllegalArgumentException
)

obtains a caption for a specified action for use in user interfaces.

Parameters
nActionIDThe identifier of the requested action.
aApplicationNameA string containing the name of the calling application.
aLocaleIs used for localization of the caption.
xPropertiesContains additional smart tag properties collected by the smart tag recognizer.
aTextThe calling application can pass the text of the smart tag to the action component.
aXMLA string that is a XML representation of the smart tag.
xControllerThe current controller of the document.
xTargetA text range representing the smart tag in the document.
Returns
the caption of the requested action.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the ActionID is not recognized.

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

Parameters
aSmartTagNameName of the wanted smart tag type. This is one of the names obtained by getSmartTagName()
xControllerThe current controller of the document.
xPropertiesContains the smart tag properties collected by the smart tag recognizer.
Returns
the number of actions available for the given smart tag type.

◆ getActionID()

long getActionID ( [in] string  aSmartTagName,
[in] long  nActionIndex,
[in] com::sun::star::frame::XController  xController 
)
raises (com::sun::star::lang::IllegalArgumentException
)

obtains a unique integer identifier for an action.

Parameters
aSmartTagNameName of the wanted smart tag type. This is one of the names obtained by getSmartTagName()
nActionIndexThe index of the action for the given smart tag type.
xControllerThe current controller of the document.
Returns
the unique integer identifier for the requested action.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the specified nActionIndex is greater than the number of available actions for the specified smart tag type.

◆ getActionNameFromID()

string getActionNameFromID ( [in] long  nActionID,
[in] com::sun::star::frame::XController  xController 
)
raises (com::sun::star::lang::IllegalArgumentException
)

obtains a language independent name of an action.

Parameters
nActionIDThe identifier of the requested action.
xControllerThe current controller of the document.
Returns
the language independent name of the specified action.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the ActionID is not recognized.

◆ getDescription()

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

obtains a detailed description of this action component.

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

◆ getName()

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

obtains a name that describes this action component.

Parameters
aLocaleIs used for localization of the name.
Returns
the name describing the action component.

◆ getSmartTagCaption()

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

obtains the caption of the smart tag type for using in user interfaces.

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 caption.
Returns
the caption associated with the smart tag type.
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 action component.

Parameters
nSmartTagIndexIndex of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively).
Returns
a 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.

◆ 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 
)
raises (com::sun::star::lang::IllegalArgumentException
)

invokes an action.

Parameters
nActionIDThe identifier of the requested action.
aApplicationNameA string containing the name of the calling application.
xControllerThe current controller of the document.
xTargetA text range representing the smart tag in the document.
xPropertiesContains the smart tag properties collected by the smart tag recognizer.
aTextThe calling application can pass the text of the smart tag to the action component.
aXMLA string that is a XML representation of the smart tag.
aLocaleIs used for localization of the action.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the ActionID is not recognized.

◆ isCaptionDynamic()

boolean isCaptionDynamic ( [in] long  nActionID,
[in] string  aApplicationName,
[in] com::sun::star::frame::XController  xController,
[in] ::com::sun::star::lang::Locale  aLocale 
)
raises (com::sun::star::lang::IllegalArgumentException
)

determines whether a caption is dynamic.

Parameters
nActionIDThe identifier of the requested action.
aApplicationNameA string containing the name of the calling application.
xControllerThe current controller of the document.
aLocaleIs used for localization.
Returns
a boolean indicating whether the caption is dynamic.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the ActionID is not recognized.

◆ isShowSmartTagIndicator()

boolean isShowSmartTagIndicator ( [in] long  nActionID,
[in] string  aApplicationName,
[in] com::sun::star::frame::XController  xController,
[in] ::com::sun::star::lang::Locale  aLocale 
)
raises (com::sun::star::lang::IllegalArgumentException
)

determines whether the smart tag indicator should be visible.

Parameters
nActionIDThe identifier of the requested action.
aApplicationNameA string containing the name of the calling application.
xControllerThe current controller of the document.
aLocaleIs used for localization.
Returns
a boolean indicating whether the smart tag indicator should be visible.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the ActionID is not recognized.

Member Data Documentation

◆ SmartTagCount

long SmartTagCount
attributereadonly

the number of smart tag types supported by this action component.


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