offapi/com/sun/star/drawing/framework/XPane2.idl

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