/* -*- 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 {
/** provides access to Deck
@since LibreOffice 5.1
*/
interface XDeck
{
/** The deck identifier
*/
string getId();
/** Get the deck title string
*/
string getTitle();
/** Set the deck title string
@param newTitle
The new title string
*/
void setTitle( [in] string newTitle );
/** Is the deck the active one
*/
boolean isActive();
/** Activate the deck and display its content
@param bActivate
The requested state for the deck
<ul>
<li>TRUE sets the deck as the active one</li>
<li>FALSE hide the deck and defaults to the first deck of the sidebar</li>
</ul>
*/
void activate( [in] boolean bActivate );
/** Get the ordering index of the deck button in sidebar
*/
long getOrderIndex();
/** Set the ordering index of the deck button in sidebar
@param newOrderIndex
The new position
*/
void setOrderIndex( [in] long newOrderIndex );
/** Move deck button at first position in sidebar
*/
void moveFirst();
/** Move deck button at last position in sidebar
*/
void moveLast();
/** Move deck one step up in the sidebar
*/
void moveUp();
/** Move deck one step down in the sidebar
*/
void moveDown();
/** Panels collection attached to the deck
*/
com::sun::star::ui::XPanels getPanels();
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
