offapi/com/sun/star/drawing/framework/XTabBar.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTabBar.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_drawing_framework_XTabBar_idl__
  32 #define __com_sun_star_drawing_framework_XTabBar_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_awt_XWindow_idl__
  38 #include <com/sun/star/awt/XWindow.idl>
  39 #endif
  40 #ifndef __com_sun_star_drawing_framework_TabBarButton_idl__
  41 #include <com/sun/star/drawing/framework/TabBarButton.idl>
  42 #endif
  43
  44 module com { module sun { module star { module drawing { module framework {
  45
  46 /** UI control for the selection of views in a pane.
  47     <p>Every tab of a tab bar has, besides its localized title and help
  48     text, the URL of a view.  A possible alternative would be to use a
  49     command URL instead of the view URL.</p>
  50     <p>In the current Impress implementation a tab bar is only used for the
  51     center pane to switch between views in the center pane.  Tab bars can
  52     make sense for other panes as well, i.e. for showing either the slide
  53     sorter or the outline view in the left pane.</p>
  54     <p>Tab bar buttons are identified by their resource id.  Note that
  55     because the resource anchors are all the same (the tab bar), it is the
  56     resource URL that really identifies a button. There can not be two
  57     buttons with the same resource id.</p>
  58     </p>
  59     <p>A better place for this interface (in an extended version) would be
  60     <code>com::sun::star::awt</code></p>
  61     @see TabBarButton
  62 */
  63 interface XTabBar
  64 {
  65     /** Add a tab bar button to the right of another one.
  66         @param aButton
  67             The new tab bar button that is to be inserted.  If a button with
  68             the same resource id is already present than that is removed before the
  69             new button is inserted.
  70         @param aAnchor
  71             The new button is inserted to the right of this button.  When
  72             its ResourceId is empty then the new button is inserted at the left
  73             most position.
  74     */
  75     void addTabBarButtonAfter ([in] TabBarButton aButton, [in] TabBarButton aAnchor);
  76
  77     /** Add a tab bar button at the right most position.
  78         @param aButton
  79             The new tab bar button that is to be inserted.
  80     */
  81     void appendTabBarButton ([in] TabBarButton aButton);
  82
  83     /** Remove a tab bar button.
  84         @param aButton
  85             The tab bar button to remove.  When there is no button with the
  86             specified resource id then this call is silently ignored.
  87     */
  88     void removeTabBarButton ([in] TabBarButton aButton);
  89
  90     /** Test whether the specified button exists in the tab bar.
  91         @param aButton
  92             The tab bar button whose existence is tested.
  93         @return
  94             Returns <TRUE/> when the button exists.
  95     */
  96     boolean hasTabBarButton ([in] TabBarButton aButton);
  97
  98     /** Return a sequence of all the tab bar buttons.
  99         <p>Their order reflects the visible order in the tab bar.</p>
 100         <p>This method can be used when
 101         <member>addTabBarButtonAfter()</member> does not provide enough
 102         control as to where to insert a new button.</p>
 103     */
 104     sequence<TabBarButton> getTabBarButtons ();
 105 };
 106
 107 }; }; }; }; }; // ::com::sun::star::drawing::framework
 108
 109 #endif