1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_awt_XDockableWindow_idl__ 24cdf0e10cSrcweir#define __com_sun_star_awt_XDockableWindow_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_awt_XDockableWindowListener_idl__ 31cdf0e10cSrcweir#include <com/sun/star/awt/XDockableWindowListener.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_awt_Rectangle_idl__ 35cdf0e10cSrcweir#include <com/sun/star/awt/Rectangle.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir 40cdf0e10cSrcweirmodule com { module sun { module star { module awt { 41cdf0e10cSrcweir 42cdf0e10cSrcweir//============================================================================= 43cdf0e10cSrcweir 44cdf0e10cSrcweir/** specifies the docking interface for a window component. 45cdf0e10cSrcweir 46cdf0e10cSrcweir <p>A window can either be docked where it resides as a child window in 47cdf0e10cSrcweir an application frame window or it can be floating where it will 48cdf0e10cSrcweir reside in its own decorated top level window. 49cdf0e10cSrcweir </p> 50cdf0e10cSrcweir */ 51cdf0e10cSrcweirinterface XDockableWindow : com::sun::star::uno::XInterface 52cdf0e10cSrcweir{ 53cdf0e10cSrcweir 54cdf0e10cSrcweir /** adds a docking listener to the object. 55cdf0e10cSrcweir only a single listener may be registered at any time. 56cdf0e10cSrcweir */ 57cdf0e10cSrcweir void addDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener ); 58cdf0e10cSrcweir 59cdf0e10cSrcweir //------------------------------------------------------------------------- 60cdf0e10cSrcweir 61cdf0e10cSrcweir /** removes the specified docking listener from the object. 62cdf0e10cSrcweir */ 63cdf0e10cSrcweir void removeDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener ); 64cdf0e10cSrcweir 65cdf0e10cSrcweir //------------------------------------------------------------------------- 66cdf0e10cSrcweir 67cdf0e10cSrcweir /** enable or disable docking, docking is disabled by default 68cdf0e10cSrcweir 69cdf0e10cSrcweir @param bEnable 70cdf0e10cSrcweir <TRUE/> specifies that docking is enabled 71cdf0e10cSrcweir <FALSE/> specifies that docking is disabled and no 72cdf0e10cSrcweir <type scope="com::sun::star::awt">XDockableWindowListener</type> will be called 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir void enableDocking( [in] boolean bEnable ); 75cdf0e10cSrcweir 76cdf0e10cSrcweir //------------------------------------------------------------------------- 77cdf0e10cSrcweir 78cdf0e10cSrcweir /** queries the current window state 79cdf0e10cSrcweir @returns 80cdf0e10cSrcweir <TRUE/> if the window is floating 81cdf0e10cSrcweir <FALSE/> if the window is docked 82cdf0e10cSrcweir */ 83cdf0e10cSrcweir boolean isFloating(); 84cdf0e10cSrcweir 85cdf0e10cSrcweir //------------------------------------------------------------------------- 86cdf0e10cSrcweir 87cdf0e10cSrcweir /** toggle between floating and docked state 88cdf0e10cSrcweir @param bFloating 89cdf0e10cSrcweir specifies the new floating mode: 90cdf0e10cSrcweir <TRUE/> means floating, <FALSE/> means docked 91cdf0e10cSrcweir */ 92cdf0e10cSrcweir void setFloatingMode( [in] boolean bFloating ); 93cdf0e10cSrcweir 94cdf0e10cSrcweir //------------------------------------------------------------------------- 95cdf0e10cSrcweir 96cdf0e10cSrcweir /** prevents the window from being undocked 97cdf0e10cSrcweir this has no effect if the window is floating 98cdf0e10cSrcweir */ 99cdf0e10cSrcweir void lock(); 100cdf0e10cSrcweir 101cdf0e10cSrcweir //------------------------------------------------------------------------- 102cdf0e10cSrcweir 103cdf0e10cSrcweir /** enables undocking 104cdf0e10cSrcweir this has no effect if the window is floating 105cdf0e10cSrcweir */ 106cdf0e10cSrcweir void unlock(); 107cdf0e10cSrcweir 108cdf0e10cSrcweir //------------------------------------------------------------------------- 109cdf0e10cSrcweir 110cdf0e10cSrcweir /** queries the current locking state 111cdf0e10cSrcweir @returns 112cdf0e10cSrcweir <TRUE/> if the window is locked 113cdf0e10cSrcweir <FALSE/> if the window is not locked 114cdf0e10cSrcweir */ 115cdf0e10cSrcweir boolean isLocked(); 116cdf0e10cSrcweir 117cdf0e10cSrcweir //------------------------------------------------------------------------- 118cdf0e10cSrcweir 119cdf0e10cSrcweir /** shows the window in a menu like style, i.e. without decoration 120cdf0e10cSrcweir a special indicator will allow for tearing off the window 121cdf0e10cSrcweir see <type scope="com::sun::star::awt">XDockableWindowListener</type> for 122cdf0e10cSrcweir the corresponding events 123cdf0e10cSrcweir @param WindowRect 124cdf0e10cSrcweir specifies the position and size of the popup window in frame coordinates 125cdf0e10cSrcweir */ 126cdf0e10cSrcweir void startPopupMode( [in] com::sun::star::awt::Rectangle WindowRect ); 127cdf0e10cSrcweir 128cdf0e10cSrcweir //------------------------------------------------------------------------- 129cdf0e10cSrcweir 130cdf0e10cSrcweir /** queries the current popup mode 131cdf0e10cSrcweir @returns 132cdf0e10cSrcweir <TRUE/> if the window is in popup mode 133cdf0e10cSrcweir <FALSE/> if the window is not in popup mode 134cdf0e10cSrcweir */ 135cdf0e10cSrcweir boolean isInPopupMode(); 136cdf0e10cSrcweir}; 137cdf0e10cSrcweir 138cdf0e10cSrcweir//============================================================================= 139cdf0e10cSrcweir 140cdf0e10cSrcweir}; }; }; }; 141cdf0e10cSrcweir 142cdf0e10cSrcweir#endif 143