offapi/com/sun/star/awt/XDockableWindow.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_XDockableWindow_idl__
  29 #define __com_sun_star_awt_XDockableWindow_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/awt/XDockableWindowListener.idl>
  33 #include <com/sun/star/awt/Rectangle.idl>
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module awt {
  38
  39 //=============================================================================
  40
  41 /** specifies the docking interface for a window component.
  42
  43     <p>A window can either be docked where it resides as a child window in
  44         an application frame window or it can be floating where it will
  45         reside in its own decorated top level window.
  46     </p>
  47  */
  48 interface XDockableWindow : com::sun::star::uno::XInterface
  49 {
  50
  51     /** adds a docking listener to the object.
  52         only a single listener may be registered at any time.
  53      */
  54     void addDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** removes the specified docking listener from the object.
  59      */
  60     void removeDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** enable or disable docking, docking is disabled by default
  65
  66         @param bEnable
  67             <TRUE/> specifies that docking is enabled
  68             <FALSE/> specifies that docking is disabled and no
  69                 <type scope="com::sun::star::awt">XDockableWindowListener</type> will be called
  70      */
  71     void enableDocking( [in] boolean bEnable );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** queries the current window state
  76         @returns
  77             <TRUE/> if the window is floating
  78             <FALSE/> if the window is docked
  79      */
  80     boolean isFloating();
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** toggle between floating and docked state
  85         @param bFloating
  86             specifies the new floating mode:
  87             <TRUE/> means floating, <FALSE/> means docked
  88      */
  89     void setFloatingMode( [in] boolean bFloating );
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** prevents the window from being undocked
  94         this has no effect if the window is floating
  95      */
  96     void lock();
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** enables undocking
 101         this has no effect if the window is floating
 102      */
 103     void unlock();
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** queries the current locking state
 108         @returns
 109             <TRUE/> if the window is locked
 110             <FALSE/> if the window is not locked
 111      */
 112     boolean isLocked();
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** shows the window in a menu like style, i.e. without decoration
 117         a special indicator will allow for tearing off the window
 118         see <type scope="com::sun::star::awt">XDockableWindowListener</type> for
 119         the corresponding events
 120         @param WindowRect
 121             specifies the position and size of the pop-up window in frame coordinates
 122      */
 123     void startPopupMode( [in] com::sun::star::awt::Rectangle WindowRect );
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** queries the current pop-up mode
 128         @returns
 129             <TRUE/> if the window is in pop-up mode
 130             <FALSE/> if the window is not in pop-up mode
 131      */
 132     boolean isInPopupMode();
 133 };
 134
 135 //=============================================================================
 136
 137 }; }; }; };
 138
 139 #endif
 140
 141 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */