INTEGRATION: CWS components1 (1.1.2); FILE ADDED

2007/01/22 13:10:13 af 1.1.2.2: #i68075 Introduction of XResourceId interface.
2006/08/23 08:28:11 af 1.1.2.1: #i68075# Initial revision.

1 files changed, 115 insertions, 0 deletions

diff --git a/offapi/com/sun/star/drawing/framework/XTabBar.idl b/offapi/com/sun/star/drawing/framework/XTabBar.idl
new file mode 100644
index 000000000000..cd999ccd0c4b
--- /dev/null
+++ b/offapi/com/sun/star/drawing/framework/XTabBar.idl
@@ -0,0 +1,115 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XTabBar.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2007-04-03 16:46:44 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#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
+    <type>com::sun::star::awt</type></p>
+    @see TabBarButton
+*/
+interface XTabBar
+    : ::com::sun::star::uno::XInterface
+{
+    /** 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