1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_drawing_framework_XPane2_idl__
29#define __com_sun_star_drawing_framework_XPane2_idl__
30
31#ifndef __com_sun_star_accessibility_XAccessible_idl__
32#include <com/sun/star/accessibility/XAccessible.idl>
33#endif
34
35module com { module sun { module star { module drawing { module framework {
36
37/** An extension of the XPane interface that adds support for
38    a) showing and hiding the windows that internally belong to the pane and
39    b) setting the accessibility object.
40    This is typically an optional interface.
41*/
42interface XPane2
43{
44    /** Return whether all windows that are used to implement the pane are
45        visible.
46        @Returns <TRUE> when all windows of the pane are visible.
47    */
48    boolean isVisible ();
49
50    /** Hide or show the pane.  If there is more than one window used to
51        implement the pane then it is left to the implementation if one,
52        some, or all windows are hidden or shown as long as the pane becomes
53        hidden or visible.
54        @param bIsVisible
55            When <TRUE> then show the pane.  Hide it otherwise.
56    */
57    void setVisible ([in] boolean bIsVisible);
58
59    /** Set the accessibility object for the pane. When there is more than
60        one window used to implement the pane then the given accessibility
61        object is usually set at the topmost window.  However, the details
62        are implementation dependent.
63        @param xAccessible
64            May be an empty reference.
65    */
66    void setAccessible ([in] ::com::sun::star::accessibility::XAccessible xAccessible);
67
68    /** Return the accessibility object that is currently associated with
69        the windows that implement the pane.
70    */
71    ::com::sun::star::accessibility::XAccessible getAccessible ();
72};
73
74}; }; }; }; }; // ::com::sun::star::drawing::framework
75
76#endif
77