offapi/com/sun/star/awt/tab/XTabPageContainer.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_tab_XTabPageContainer_idl__
  29 #define __com_sun_star_awt_tab_XTabPageContainer_idl__
  30
  31 #include <com/sun/star/awt/tab/XTabPageContainerListener.idl>
  32 #include <com/sun/star/awt/tab/XTabPage.idl>
  33 //=============================================================================
  34
  35 module com {  module sun {  module star {  module awt { module tab {
  36
  37 //=============================================================================
  38
  39 /** An interface to a control that displays tab pages.
  40
  41     @see UnoControlTabPageContainer
  42
  43     @since OOo 3.4
  44  */
  45 interface XTabPageContainer
  46 {
  47     /** Returns the number of tab pages.
  48         @returns
  49             the number of tab pages.
  50     */
  51     long getTabPageCount();
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** Checks whether a tab page is activated.
  56         @param
  57             the tab page to be checked.
  58         @returns
  59             <TRUE/> if tab page is activated, else <FALSE/>.
  60     */
  61     boolean isTabPageActive([in] short tabPageIndex);
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** Returns tab page for the given index.
  66         @param
  67             tabPageIndex - index of the tab page in the IndexContainer.
  68         @returns
  69             tab page which has tabPageIndex.
  70     */
  71     XTabPage getTabPage([in] short tabPageIndex);
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** Returns tab page for the given ID.
  76         @param
  77             tabPageID - ID of the tab page.
  78         @returns
  79             tab page which has tabPageID.
  80     */
  81     XTabPage getTabPageByID([in] short tabPageID);
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** Adds a listener for the <type>TabPageActivedEvent</type> posted after
  86         the tab page was activated.
  87         @param listener
  88             the listener to add.
  89     */
  90     [oneway] void addTabPageListener( [in] XTabPageContainerListener  listener);
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** Removes a listener previously added with <method>addTabPageListener()</method>.
  95         @param listener
  96             the listener to remove.
  97     */
  98     [oneway] void removeTabPageListener( [in] XTabPageContainerListener listener);
  99
 100     //-------------------------------------------------------------------------
 101     /** Specifies the ID of the current active tab page.
 102     */
 103     [attribute] short ActiveTabPageID;
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; }; };
 109
 110 #endif
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */