describes a container of user actions. More...
import"ActionTriggerContainer.idl";
Inheritance diagram for ActionTriggerContainer:
Exported Interfaces | |
| interface | ::com::sun::star::container::XIndexContainer |
| provides access to the entries of a menu. More... | |
| interface | ::com::sun::star::lang::XMultiServiceFactory |
| creates elements to be inserted into the container. More... | |
| interface | ::com::sun::star::container::XEnumerationAccess |
| allows to enumerate the elements of the container More... | |
| interface | ::com::sun::star::container::XContainer |
| allows foreign components to register themselves as listener for the container structure. More... | |
Additional Inherited Members | |
 Public Member Functions inherited from XIndexContainer | |
| void | insertByIndex ([in] long Index, [in] any Element) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException ) |
| inserts the given element at the specified index. More... | |
| void | removeByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException ) |
| removes the element at the specified index. More... | |
| Public Member Functions inherited from XIndexReplace | |
| void | replaceByIndex ([in] long Index, [in] any Element) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException ) |
| replaces the element at the specified index with the given element. More... | |
| Public Member Functions inherited from XIndexAccess | |
| long | getCount () |
| any | getByIndex ([in] long Index) raises ( com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException ) |
| Public Member Functions inherited from XElementAccess | |
| type | getElementType () |
| boolean | hasElements () |
| 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 Member Functions inherited from XMultiServiceFactory | |
| com::sun::star::uno::XInterface | createInstance ([in] string aServiceSpecifier) raises ( com::sun::star::uno::Exception ) |
| Creates an instance classified by the specified name. More... | |
| com::sun::star::uno::XInterface | createInstanceWithArguments ([in] string ServiceSpecifier, [in] sequence< any > Arguments) raises ( com::sun::star::uno::Exception ) |
| Creates an instance classified by the specified name and passes the arguments to that instance. More... | |
| sequence< string > | getAvailableServiceNames () |
| Provides the available names of the factory to be used to create instances. More... | |
| Protected Member Functions inherited from XEnumerationAccess | |
| com::sun::star::container::XEnumeration | createEnumeration () |
| Protected Member Functions inherited from XContainer | |
| void | addContainerListener ([in] com::sun::star::container::XContainerListener xListener) |
| adds the specified listener to receive events when elements are inserted or removed. More... | |
| void | removeContainerListener ([in] com::sun::star::container::XContainerListener xListener) |
| removes the specified listener so it does not receive any events from this container. More... | |
Detailed Description
describes a container of user actions.
No assumption is made about any graphical representation: You could have a menu or a toolbox working with the same container describing their entries.
Possible elements of the ActionTriggerContainer are
- ActionTrigger - represents a simply clickable menu entry
-
ActionTriggerSeparator - represents a separator between two entries
This entry type is of interest for components rendering a an ActionTriggerContainer - ActionTriggerContainer - represents a sub container
Exported Interfaces
◆ ::com::sun::star::container::XContainer
|
optional |
allows foreign components to register themselves as listener for the container structure.
◆ ::com::sun::star::container::XEnumerationAccess
|
optional |
allows to enumerate the elements of the container
◆ ::com::sun::star::container::XIndexContainer
| interface ::com::sun::star::container::XIndexContainer |
provides access to the entries of a menu.
The element type is com::sun::star::beans::XPropertySet. The property set contains attributes like CommandURL, HelpURL as defined in the service com::sun::star::ui::ActionTrigger and optional a com::sun::star::ui::ActionTriggerContainer.
◆ ::com::sun::star::lang::XMultiServiceFactory
| interface ::com::sun::star::lang::XMultiServiceFactory |
creates elements to be inserted into the container.
Usually, the XMultiServiceFactory::getSupportedServiceNames() gives you an ActionTrigger and optionally ActionTriggerContainer and ActionTriggerSeparator
.
The documentation for this service was generated from the following file:
- com/sun/star/ui/ActionTriggerContainer.idl
