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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_tab_XTabPageContainer_idl__
  20 #define __com_sun_star_awt_tab_XTabPageContainer_idl__
  21
  22 #include <com/sun/star/awt/tab/XTabPageContainerListener.idl>
  23 #include <com/sun/star/awt/tab/XTabPage.idl>
  24
  25 module com {  module sun {  module star {  module awt { module tab {
  26
  27
  28 /** An interface to a control that displays tab pages.
  29
  30     @see UnoControlTabPageContainer
  31
  32     @since OOo 3.4
  33  */
  34 published interface XTabPageContainer
  35 {
  36     /** Returns the number of tab pages.
  37         @returns
  38             the number of tab pages.
  39     */
  40     short getTabPageCount();
  41
  42
  43     /** Checks whether a tab page is activated.
  44         @param tabPageIndex
  45             the tab page to be checked.
  46         @returns
  47             `TRUE` if tab page is activated, else `FALSE`.
  48     */
  49     boolean isTabPageActive([in] short tabPageIndex);
  50
  51
  52     /** Returns tab page for the given index.
  53         @param
  54             tabPageIndex - index of the tab page in the IndexContainer.
  55         @returns
  56             tab page which has tabPageIndex.
  57     */
  58     XTabPage getTabPage([in] short tabPageIndex);
  59
  60
  61     /** Returns tab page for the given ID.
  62         @param
  63             tabPageID - ID of the tab page.
  64         @returns
  65             tab page which has tabPageID.
  66     */
  67     XTabPage getTabPageByID([in] short tabPageID);
  68
  69
  70     /** Adds a listener for the TabPageActivedEvent posted after
  71         the tab page was activated.
  72         @param listener
  73             the listener to add.
  74     */
  75     void addTabPageContainerListener( [in] XTabPageContainerListener  listener);
  76
  77
  78     /** Removes a listener previously added with addTabPageListener().
  79         @param listener
  80             the listener to remove.
  81     */
  82     void removeTabPageContainerListener( [in] XTabPageContainerListener listener);
  83
  84     /** Specifies the ID of the current active tab page.
  85     */
  86     [attribute] short ActiveTabPageID;
  87 };
  88
  89
  90 }; }; }; }; };
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */