offapi/com/sun/star/awt/XDockableWindow.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: XDockableWindow.idl,v $
  10  * $Revision: 1.5 $
  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 #ifndef __com_sun_star_awt_XDockableWindow_idl__
  31 #define __com_sun_star_awt_XDockableWindow_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XDockableWindowListener_idl__
  38 #include <com/sun/star/awt/XDockableWindowListener.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_Rectangle_idl__
  42 #include <com/sun/star/awt/Rectangle.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module awt {
  48
  49 //=============================================================================
  50
  51 /** specifies the docking interface for a window component.
  52
  53     <p>A window can either be docked where it resides as a child window in
  54         an application frame window or it can be floating where it will
  55         reside in its own decorated top level window.
  56     </p>
  57  */
  58 interface XDockableWindow : com::sun::star::uno::XInterface
  59 {
  60
  61     /** adds a docking listener to the object.
  62         only a single listener may be registered at any time.
  63      */
  64     void addDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** removes the specified docking listener from the object.
  69      */
  70     void removeDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** enable or disable docking, docking is disabled by default
  75
  76         @param bEnable
  77             <TRUE/> specifies that docking is enabled
  78             <FALSE/> specifies that docking is disabled and no
  79                 <type scope="com::sun::star::awt">XDockableWindowListener</type> will be called
  80      */
  81     void enableDocking( [in] boolean bEnable );
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** queries the current window state
  86         @returns
  87             <TRUE/> if the window is floating
  88             <FALSE/> if the window is docked
  89      */
  90     boolean isFloating();
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** toggle between floating and docked state
  95         @param bFloating
  96             specifies the new floating mode:
  97             <TRUE/> means floating, <FALSE/> means docked
  98      */
  99     void setFloatingMode( [in] boolean bFloating );
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** prevents the window from being undocked
 104         this has no effect if the window is floating
 105      */
 106     void lock();
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** enables undocking
 111         this has no effect if the window is floating
 112      */
 113     void unlock();
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** queries the current locking state
 118         @returns
 119             <TRUE/> if the window is locked
 120             <FALSE/> if the window is not locked
 121      */
 122     boolean isLocked();
 123
 124     //-------------------------------------------------------------------------
 125
 126     /** shows the window in a menu like style, i.e. without decoration
 127         a special indicator will allow for tearing off the window
 128         see <type scope="com::sun::star::awt">XDockableWindowListener</type> for
 129         the corresponding events
 130         @param WindowRect
 131             specifies the position and size of the popup window in frame coordinates
 132      */
 133     void startPopupMode( [in] com::sun::star::awt::Rectangle WindowRect );
 134
 135     //-------------------------------------------------------------------------
 136
 137     /** queries the current popup mode
 138         @returns
 139             <TRUE/> if the window is in popup mode
 140             <FALSE/> if the window is not in popup mode
 141      */
 142     boolean isInPopupMode();
 143 };
 144
 145 //=============================================================================
 146
 147 }; }; }; };
 148
 149 #endif