/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
#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 tabPageIndex
            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 TabPageActivedEvent posted after
        the tab page was activated.
        @param listener
            the listener to add.
    */
    void addTabPageContainerListener( [in] XTabPageContainerListener  listener);


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

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


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
