LibreOffice
LibreOffice 5.1 SDK API Reference
|
specifies the basic operations for a tab controller, but does not require XControl as type of tabs. More...
import"XSimpleTabController.idl";
Public Member Functions | |
long | insertTab () |
create a new tab and return an unique ID, which can be used further to address this tab by using other methods of this interface. More... | |
void | removeTab ([in] long ID) raises ( com::sun::star::lang::IndexOutOfBoundsException ) |
remove a tab with the given ID. More... | |
void | setTabProps ([in] long ID, [in] sequence< com::sun::star::beans::NamedValue > Properties) raises ( com::sun::star::lang::IndexOutOfBoundsException ) |
change some properties of the specified tab. More... | |
sequence< com::sun::star::beans::NamedValue > | getTabProps ([in] long ID) raises ( com::sun::star::lang::IndexOutOfBoundsException ) |
retrieve the set of properties for the specified tab. More... | |
void | activateTab ([in] long ID) raises ( com::sun::star::lang::IndexOutOfBoundsException ) |
activate the specified tab. More... | |
long | getActiveTabID () |
return the unique ID of the current active tab. More... | |
void | addTabListener ([in] XTabListener Listener) |
register listener for inserting/removing tabs and changing their properties. More... | |
void | removeTabListener ([in] XTabListener Listener) |
unregister listener for inserting/removing tabs and changing their properties. More... | |
![]() | |
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... | |
specifies the basic operations for a tab controller, but does not require XControl as type of tabs.
void activateTab | ( | [in] long | ID | ) | |
raises | ( | com::sun::star::lang::IndexOutOfBoundsException | |||
) |
activate the specified tab.
The new tab will be activated and all listener will get an event describing this. Of course there will be an event too, which notifies listener about the deactivation of the last active tab.
ID | the ID of the new active tab. |
com::sun::star::lang::IndexOutOfBoundsException | if the specified ID isn't used inside this tab controller. |
void addTabListener | ( | [in] XTabListener | Listener | ) |
register listener for inserting/removing tabs and changing their properties.
Listener | the listener to register. |
long getActiveTabID | ( | ) |
return the unique ID of the current active tab.
sequence< com::sun::star::beans::NamedValue > getTabProps | ( | [in] long | ID | ) | |
raises | ( | com::sun::star::lang::IndexOutOfBoundsException | |||
) |
retrieve the set of properties for the specified tab.
ID | the ID of the tab. |
com::sun::star::lang::IndexOutOfBoundsException | if the specified ID isn't used inside this tab controller. |
long insertTab | ( | ) |
create a new tab and return an unique ID, which can be used further to address this tab by using other methods of this interface.
void removeTab | ( | [in] long | ID | ) | |
raises | ( | com::sun::star::lang::IndexOutOfBoundsException | |||
) |
remove a tab with the given ID.
ID | the ID of the tab, which should be removed. |
com::sun::star::lang::IndexOutOfBoundsException | if the specified ID isn't used inside this tab controller. |
void removeTabListener | ( | [in] XTabListener | Listener | ) |
unregister listener for inserting/removing tabs and changing their properties.
Listener | the listener to unregister. |
void setTabProps | ( | [in] long | ID, |
[in] sequence< com::sun::star::beans::NamedValue > | Properties | ||
) | |||
raises | ( | com::sun::star::lang::IndexOutOfBoundsException | |
) |
change some properties of the specified tab.
Such properties can be:
Property | Type | Description |
Title | string | the title of the tab, which is shown at the UI. |
Position | int | describe the order of this tab in relation to all other tabs inside this control. |
ID | the ID of the tab, which should be changed. |
com::sun::star::lang::IndexOutOfBoundsException | if the specified ID isn't used inside this tab controller. |