Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: drawing :: framework ::

unpublished interface XTabBar
Usage Restrictions
not published
Description
UI control for the selection of views in a pane.

Every tab of a tab bar has, besides its localized title and help text, the URL of a view. A possible alternative would be to use a command URL instead of the view URL.

In the current Impress implementation a tab bar is only used for the center pane to switch between views in the center pane. Tab bars can make sense for other panes as well, i.e. for showing either the slide sorter or the outline view in the left pane.

Tab bar buttons are identified by their resource id. Note that because the resource anchors are all the same (the tab bar), it is the resource URL that really identifies a button. There can not be two buttons with the same resource id.

A better place for this interface (in an extended version) would be com::sun::star::awt

See also
TabBarButton

Methods' Summary
addTabBarButtonAfter Add a tab bar button to the right of another one.  
appendTabBarButton Add a tab bar button at the right most position.  
removeTabBarButton Remove a tab bar button.  
hasTabBarButton Test whether the specified button exists in the tab bar.  
getTabBarButtons Return a sequence of all the tab bar buttons.  
Methods' Details
addTabBarButtonAfter
void
addTabBarButtonAfter( [in] TabBarButton  aButton,
[in] TabBarButton  aAnchor );

Description
Add a tab bar button to the right of another one.
Parameter aButton
The new tab bar button that is to be inserted. If a button with the same resource id is already present than that is removed before the new button is inserted.
Parameter aAnchor
The new button is inserted to the right of this button. When its ResourceId is empty then the new button is inserted at the left most position.
appendTabBarButton
void
appendTabBarButton( [in] TabBarButton  aButton );

Description
Add a tab bar button at the right most position.
Parameter aButton
The new tab bar button that is to be inserted.
removeTabBarButton
void
removeTabBarButton( [in] TabBarButton  aButton );

Description
Remove a tab bar button.
Parameter aButton
The tab bar button to remove. When there is no button with the specified resource id then this call is silently ignored.
hasTabBarButton
boolean
hasTabBarButton( [in] TabBarButton  aButton );

Description
Test whether the specified button exists in the tab bar.
Parameter aButton
The tab bar button whose existence is tested.
Returns
Returns true when the button exists.
getTabBarButtons
sequence< TabBarButton >
getTabBarButtons();

Description
Return a sequence of all the tab bar buttons.

Their order reflects the visible order in the tab bar.

This method can be used when addTabBarButtonAfter() does not provide enough control as to where to insert a new button.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.