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