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
  20 module com {  module sun {  module star {  module awt { module tab {
  21
  22
  23 /** An interface to a control that displays tab pages.
  24
  25     @see UnoControlTabPageContainer
  26
  27     @since OOo 3.4
  28  */
  29 published interface XTabPageContainer
  30 {
  31     /** Returns the number of tab pages.
  32         @returns
  33             the number of tab pages.
  34     */
  35     short getTabPageCount();
  36
  37
  38     /** Checks whether a tab page is activated.
  39         @param tabPageIndex
  40             the tab page to be checked.
  41         @returns
  42             `TRUE` if tab page is activated, else `FALSE`.
  43     */
  44     boolean isTabPageActive([in] short tabPageIndex);
  45
  46
  47     /** Returns tab page for the given index.
  48         @param
  49             tabPageIndex - index of the tab page in the IndexContainer.
  50         @returns
  51             tab page which has tabPageIndex.
  52     */
  53     XTabPage getTabPage([in] short tabPageIndex);
  54
  55
  56     /** Returns tab page for the given ID.
  57         @param
  58             tabPageID - ID of the tab page.
  59         @returns
  60             tab page which has tabPageID.
  61     */
  62     XTabPage getTabPageByID([in] short tabPageID);
  63
  64
  65     /** Adds a listener for the TabPageActivedEvent posted after
  66         the tab page was activated.
  67         @param listener
  68             the listener to add.
  69     */
  70     void addTabPageContainerListener( [in] XTabPageContainerListener  listener);
  71
  72
  73     /** Removes a listener previously added with addTabPageListener().
  74         @param listener
  75             the listener to remove.
  76     */
  77     void removeTabPageContainerListener( [in] XTabPageContainerListener listener);
  78
  79     /** Specifies the ID of the current active tab page.
  80     */
  81     [attribute] short ActiveTabPageID;
  82 };
  83
  84
  85 }; }; }; }; };
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */