|
LibreOffice
LibreOffice 24.8 SDK API Reference
|
provides access to smart tag actions. More...
import "XSmartTagAction.idl";
Public Member Functions | |
| string | getName ([in] ::com::sun::star::lang::Locale aLocale) |
| obtains a name that describes this action component. | |
| string | getDescription ([in] ::com::sun::star::lang::Locale aLocale) |
| obtains a detailed description of this action component. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| Public Member Functions inherited from XInitialization | |
| void | initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception ) |
| initializes the object. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. | |
| void | acquire () |
| increases the reference counter by one. | |
| void | release () |
| decreases the reference counter by one. | |
Public Attributes | |
| long | SmartTagCount |
| the number of smart tag types supported by this action component. | |
provides access to smart tag actions.
| 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.
| nActionID | The identifier of the requested action. |
| aApplicationName | A string containing the name of the calling application. |
| aLocale | Is used for localization of the caption. |
| xProperties | Contains additional smart tag properties collected by the smart tag recognizer. |
| aText | The calling application can pass the text of the smart tag to the action component. |
| aXML | A string that is a XML representation of the smart tag. |
| xController | The current controller of the document. |
| xTarget | A text range representing the smart tag in the document. |
| com::sun::star::lang::IllegalArgumentException | if the ActionID is not recognized. |
| 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.
| aSmartTagName | Name of the wanted smart tag type. This is one of the names obtained by getSmartTagName() |
| xController | The current controller of the document. |
| xProperties | Contains the smart tag properties collected by the smart tag recognizer. |
| 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.
| aSmartTagName | Name of the wanted smart tag type. This is one of the names obtained by getSmartTagName() |
| nActionIndex | The index of the action for the given smart tag type. |
| xController | The current controller of the document. |
| com::sun::star::lang::IllegalArgumentException | if the specified nActionIndex is greater than the number of available actions for the specified smart tag type. |
| 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.
| nActionID | The identifier of the requested action. |
| xController | The current controller of the document. |
| com::sun::star::lang::IllegalArgumentException | if the ActionID is not recognized. |
| string getDescription | ( | [in] ::com::sun::star::lang::Locale | aLocale | ) |
obtains a detailed description of this action component.
| aLocale | Is used for localization of the description. |
| string getName | ( | [in] ::com::sun::star::lang::Locale | aLocale | ) |
obtains a name that describes this action component.
| aLocale | Is used for localization of the name. |
| 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.
| nSmartTagIndex | Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). |
| aLocale | Is used for localization of the caption. |
| com::sun::star::lang::IndexOutOfBoundsException | if nSmartTagIndex is greater than SmartTagCount |
| 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.
| nSmartTagIndex | Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). |
| com::sun::star::lang::IndexOutOfBoundsException | if nSmartTagIndex is greater than SmartTagCount. |
| 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.
| nActionID | The identifier of the requested action. |
| aApplicationName | A string containing the name of the calling application. |
| xController | The current controller of the document. |
| xTarget | A text range representing the smart tag in the document. |
| xProperties | Contains the smart tag properties collected by the smart tag recognizer. |
| aText | The calling application can pass the text of the smart tag to the action component. |
| aXML | A string that is a XML representation of the smart tag. |
| aLocale | Is used for localization of the action. |
| com::sun::star::lang::IllegalArgumentException | if the ActionID is not recognized. |
| 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.
| nActionID | The identifier of the requested action. |
| aApplicationName | A string containing the name of the calling application. |
| xController | The current controller of the document. |
| aLocale | Is used for localization. |
| com::sun::star::lang::IllegalArgumentException | if the ActionID is not recognized. |
| 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.
| nActionID | The identifier of the requested action. |
| aApplicationName | A string containing the name of the calling application. |
| xController | The current controller of the document. |
| aLocale | Is used for localization. |
| com::sun::star::lang::IllegalArgumentException | if the ActionID is not recognized. |
|
attributereadonly |
the number of smart tag types supported by this action component.