1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_tab_XTabPageContainer_idl__
24#define __com_sun_star_awt_tab_XTabPageContainer_idl__
25
26#include <com/sun/star/awt/tab/XTabPageContainerListener.idl>
27#include <com/sun/star/awt/tab/XTabPage.idl>
28//=============================================================================
29
30module com {  module sun {  module star {  module awt { module tab {
31
32//=============================================================================
33
34/** An interface to a control that displays tab pages.
35
36	@see UnoControlTabPageContainer
37
38	@since OpenOffice 3.4
39 */
40published interface XTabPageContainer
41{
42	/** Returns the number of tab pages.
43		@returns
44			the number of tab pages.
45	*/
46	short getTabPageCount();
47
48    //-------------------------------------------------------------------------
49
50    /** Checks whether a tab page is activated.
51        @param
52            the tab page to be checked.
53        @returns
54            <TRUE/> if tab page is activated, else <FALSE/>.
55    */
56    boolean isTabPageActive([in] short tabPageIndex);
57
58    //-------------------------------------------------------------------------
59
60    /** Returns tab page for the given index.
61        @param
62            tabPageIndex - index of the tab page in the IndexContainer.
63        @returns
64            tab page which has tabPageIndex.
65    */
66    XTabPage getTabPage([in] short tabPageIndex);
67
68    //-------------------------------------------------------------------------
69
70    /** Returns tab page for the given ID.
71        @param
72            tabPageID - ID of the tab page.
73        @returns
74            tab page which has tabPageID.
75    */
76    XTabPage getTabPageByID([in] short tabPageID);
77
78    //-------------------------------------------------------------------------
79
80    /** Adds a listener for the <type>TabPageActivedEvent</type> posted after
81        the tab page was activated.
82        @param listener
83            the listener to add.
84    */
85    [oneway] void addTabPageContainerListener( [in] XTabPageContainerListener  listener);
86
87    //-------------------------------------------------------------------------
88
89    /** Removes a listener previously added with <method>addTabPageListener()</method>.
90        @param listener
91            the listener to remove.
92    */
93    [oneway] void removeTabPageContainerListener( [in] XTabPageContainerListener listener);
94
95    //-------------------------------------------------------------------------
96    /** Specifies the ID of the current active tab page.
97    */
98    [attribute] short ActiveTabPageID;
99};
100
101//=============================================================================
102
103}; }; }; }; };
104
105#endif
106