Impressum XSidebarProvider.idl   Sprache: unbekannt

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 */


module com { module sun { module star { module ui {

/** Interface of the sidebar
    @since LibreOffice 5.1
*/
interface XSidebarProvider: com::sun::star::uno::XInterface
{
    /** Display the sidebar

        @param bVisible
            the requested visible state
    */
    void setVisible ( [in] boolean bVisible);

    /** Is the sidebar visible
    */
    boolean isVisible();

    /** Get the XFrame owner
    */
    com::sun::star::frame::XFrame getFrame();

    /* Decks collection attached to the sidebar
    */
    com::sun::star::ui::XDecks getDecks();

    /** Decks container visibility

        @param bVisible
            the requested visible state
            <ul>
            <li>FALSE collapses the deck container horizontally. Then Only shows the deck TabBar selector</li>
            <li>TRUE  expands the deck container and show active Deck content</li>
            </ul>
    */
    void showDecks([in] boolean bVisible);

    /**
     * Returns the sidebar object
     */
    com::sun::star::ui::XSidebar getSidebar();
} ;

} ; } ; } ; } ;

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */