offapi/com/sun/star/ui/XPanel.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  */
  10
  11
  12  module com {  module sun {  module star {  module ui {
  13
  14 /** provides access to Panel
  15     @since LibreOffice 5.1
  16 */
  17
  18 interface XPanel
  19
  20 {
  21     /** The panel identifier
  22     */
  23     string getId();
  24
  25     /** Get the panel title string
  26     */
  27     string getTitle();
  28
  29     /** Set the panel title string
  30
  31         @param newTitle
  32             The new title string
  33     */
  34     void setTitle( [in] string newTitle );
  35
  36     /** Is the panel expanded
  37     */
  38     boolean isExpanded();
  39
  40     /** Collapse the panel to only show its title bar
  41     */
  42     void collapse ();
  43
  44     /** Expand and display the panel
  45
  46         @param bCollapseOther
  47             <ul>
  48             <li>TRUE collapse all other panels of the deck</li>
  49             <li>FALSE do not change other panels state</li>
  50             </ul>
  51     */
  52     void expand ( [in] boolean bCollapseOther );
  53
  54     /** Get the ordering index of the panel in the deck
  55     */
  56     long getOrderIndex();
  57
  58     /** Set the ordering index of the panel in the deck
  59     */
  60     void setOrderIndex( [in] long newOrderIndex );
  61
  62     /** Move panel as first item of the deck
  63     */
  64     void moveFirst();
  65
  66     /** Move panel as last item of the deck
  67     **/
  68     void moveLast();
  69
  70     /** Move panel one step up in the deck
  71     */
  72     void moveUp();
  73
  74     /** Move the panel one step down in the deck
  75     */
  76     void moveDown();
  77
  78     /** Get the panel dialog element
  79     */
  80     com::sun::star::awt::XWindow getDialog();
  81
  82 };
  83
  84
  85 }; }; }; };
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */