offapi/com/sun/star/ui/XSidebarProvider.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 /** Interface of the sidebar
  15     @since LibreOffice 5.1
  16 */
  17 interface XSidebarProvider: com::sun::star::uno::XInterface
  18 {
  19     /** Display the sidebar
  20
  21         @param bVisible
  22             the requested visible state
  23     */
  24     void setVisible ( [in] boolean bVisible);
  25
  26     /** Is the sidebar visible
  27     */
  28     boolean isVisible();
  29
  30     /** Get the XFrame owner
  31     */
  32     com::sun::star::frame::XFrame getFrame();
  33
  34     /* Decks collection attached to the sidebar
  35     */
  36     com::sun::star::ui::XDecks getDecks();
  37
  38     /** Decks container visibility
  39
  40         @param bVisible
  41             the requested visible state
  42             <ul>
  43             <li>FALSE collapses the deck container horizontally. Then Only shows the deck TabBar selector</li>
  44             <li>TRUE  expands the deck container and show active Deck content</li>
  45             </ul>
  46     */
  47     void showDecks([in] boolean bVisible);
  48
  49     /**
  50      * Returns the sidebar object
  51      */
  52     com::sun::star::ui::XSidebar getSidebar();
  53 } ;
  54
  55 } ; } ; } ; } ;
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */