offapi/com/sun/star/ui/XDeck.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 Deck
  15     @since LibreOffice 5.1
  16 */
  17
  18 interface XDeck
  19
  20 {
  21     /** The deck identifier
  22     */
  23     string getId();
  24
  25     /** Get the deck title string
  26     */
  27     string getTitle();
  28
  29     /** Set the deck title string
  30
  31         @param newTitle
  32             The new title string
  33     */
  34     void setTitle( [in] string newTitle );
  35
  36     /** Is the deck the active one
  37     */
  38     boolean isActive();
  39
  40     /** Activate the deck and display its content
  41
  42         @param bActivate
  43             The requested state for the deck
  44             <ul>
  45             <li>TRUE sets the deck as the active one</li>
  46             <li>FALSE hide the deck and defaults to the first deck of the sidebar</li>
  47             </ul>
  48     */
  49     void activate( [in] boolean bActivate );
  50
  51     /** Get the ordering index of the deck button in sidebar
  52     */
  53     long getOrderIndex();
  54
  55     /** Set the ordering index of the deck button in sidebar
  56
  57         @param newOrderIndex
  58         The new position
  59     */
  60     void setOrderIndex( [in] long newOrderIndex );
  61
  62     /** Move deck button at first position in sidebar
  63     */
  64     void moveFirst();
  65
  66     /** Move deck button at last position in sidebar
  67     */
  68     void moveLast();
  69
  70     /** Move deck one step up in the sidebar
  71     */
  72     void moveUp();
  73
  74     /** Move deck one step down in the sidebar
  75     */
  76     void moveDown();
  77
  78     /** Panels collection attached to the deck
  79     */
  80     com::sun::star::ui::XPanels getPanels();
  81 };
  82
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */