xref: /aoo41x/main/offapi/com/sun/star/awt/tab/XTabPageContainer.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_tab_XTabPageContainer_idl__
#define __com_sun_star_awt_tab_XTabPageContainer_idl__

#include <com/sun/star/awt/tab/XTabPageContainerListener.idl>
#include <com/sun/star/awt/tab/XTabPage.idl>
//=============================================================================

module com {  module sun {  module star {  module awt { module tab {

//=============================================================================

/** An interface to a control that displays tab pages.

	@see UnoControlTabPageContainer

	@since OOo 3.4
 */
published interface XTabPageContainer
{
	/** Returns the number of tab pages.
		@returns
			the number of tab pages.
	*/
	short getTabPageCount();

    //-------------------------------------------------------------------------

    /** Checks whether a tab page is activated.
        @param
            the tab page to be checked.
        @returns
            <TRUE/> if tab page is activated, else <FALSE/>.
    */
    boolean isTabPageActive([in] short tabPageIndex);

    //-------------------------------------------------------------------------

    /** Returns tab page for the given index.
        @param
            tabPageIndex - index of the tab page in the IndexContainer.
        @returns
            tab page which has tabPageIndex.
    */
    XTabPage getTabPage([in] short tabPageIndex);

    //-------------------------------------------------------------------------

    /** Returns tab page for the given ID.
        @param
            tabPageID - ID of the tab page.
        @returns
            tab page which has tabPageID.
    */
    XTabPage getTabPageByID([in] short tabPageID);

    //-------------------------------------------------------------------------

    /** Adds a listener for the <type>TabPageActivedEvent</type> posted after
        the tab page was activated.
        @param listener
            the listener to add.
    */
    [oneway] void addTabPageContainerListener( [in] XTabPageContainerListener  listener);

    //-------------------------------------------------------------------------

    /** Removes a listener previously added with <method>addTabPageListener()</method>.
        @param listener
            the listener to remove.
    */
    [oneway] void removeTabPageContainerListener( [in] XTabPageContainerListener listener);

    //-------------------------------------------------------------------------
    /** Specifies the ID of the current active tab page.
    */
    [attribute] short ActiveTabPageID;
};

//=============================================================================

}; }; }; }; };

#endif