| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_drawing_framework_XTabBar_idl__ |
| #define __com_sun_star_drawing_framework_XTabBar_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| #ifndef __com_sun_star_awt_XWindow_idl__ |
| #include <com/sun/star/awt/XWindow.idl> |
| #endif |
| #ifndef __com_sun_star_drawing_framework_TabBarButton_idl__ |
| #include <com/sun/star/drawing/framework/TabBarButton.idl> |
| #endif |
| |
| module com { module sun { module star { module drawing { module framework { |
| |
| /** UI control for the selection of views in a pane. |
| <p>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.</p> |
| <p>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.</p> |
| <p>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.</p> |
| </p> |
| <p>A better place for this interface (in an extended version) would be |
| <code>com::sun::star::awt</code></p> |
| @see TabBarButton |
| */ |
| interface XTabBar |
| { |
| /** Add a tab bar button to the right of another one. |
| @param 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. |
| @param 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. |
| */ |
| void addTabBarButtonAfter ([in] TabBarButton aButton, [in] TabBarButton aAnchor); |
| |
| /** Add a tab bar button at the right most position. |
| @param aButton |
| The new tab bar button that is to be inserted. |
| */ |
| void appendTabBarButton ([in] TabBarButton aButton); |
| |
| /** Remove a tab bar button. |
| @param aButton |
| The tab bar button to remove. When there is no button with the |
| specified resource id then this call is silently ignored. |
| */ |
| void removeTabBarButton ([in] TabBarButton aButton); |
| |
| /** Test whether the specified button exists in the tab bar. |
| @param aButton |
| The tab bar button whose existence is tested. |
| @return |
| Returns <TRUE/> when the button exists. |
| */ |
| boolean hasTabBarButton ([in] TabBarButton aButton); |
| |
| /** Return a sequence of all the tab bar buttons. |
| <p>Their order reflects the visible order in the tab bar.</p> |
| <p>This method can be used when |
| <member>addTabBarButtonAfter()</member> does not provide enough |
| control as to where to insert a new button.</p> |
| */ |
| sequence<TabBarButton> getTabBarButtons (); |
| }; |
| |
| }; }; }; }; }; // ::com::sun::star::drawing::framework |
| |
| #endif |