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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XDockableWindow_idl__
  20 #define __com_sun_star_awt_XDockableWindow_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/awt/XDockableWindowListener.idl>
  24 #include <com/sun/star/awt/Rectangle.idl>
  25
  26
  27 module com {  module sun {  module star {  module awt {
  28
  29
  30 /** specifies the docking interface for a window component.
  31
  32     <p>A window can either be docked where it resides as a child window in
  33         an application frame window or it can be floating where it will
  34         reside in its own decorated top level window.
  35     </p>
  36  */
  37 interface XDockableWindow : com::sun::star::uno::XInterface
  38 {
  39
  40     /** adds a docking listener to the object.
  41         only a single listener may be registered at any time.
  42      */
  43     void addDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
  44
  45
  46     /** removes the specified docking listener from the object.
  47      */
  48     void removeDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
  49
  50
  51     /** enable or disable docking, docking is disabled by default
  52
  53         @param bEnable
  54             `TRUE` specifies that docking is enabled
  55             `FALSE` specifies that docking is disabled and no
  56                 com::sun::star::awt::XDockableWindowListener will be called
  57      */
  58     void enableDocking( [in] boolean bEnable );
  59
  60
  61     /** queries the current window state
  62         @returns
  63             `TRUE` if the window is floating
  64             `FALSE` if the window is docked
  65      */
  66     boolean isFloating();
  67
  68
  69     /** toggle between floating and docked state
  70         @param bFloating
  71             specifies the new floating mode:
  72             `TRUE` means floating, `FALSE` means docked
  73      */
  74     void setFloatingMode( [in] boolean bFloating );
  75
  76
  77     /** prevents the window from being undocked
  78         this has no effect if the window is floating
  79      */
  80     void lock();
  81
  82
  83     /** enables undocking
  84         this has no effect if the window is floating
  85      */
  86     void unlock();
  87
  88
  89     /** queries the current locking state
  90         @returns
  91             `TRUE` if the window is locked
  92             `FALSE` if the window is not locked
  93      */
  94     boolean isLocked();
  95
  96
  97     /** shows the window in a menu like style, i.e. without decoration
  98         a special indicator will allow for tearing off the window
  99         see com::sun::star::awt::XDockableWindowListener for
 100         the corresponding events
 101         @param WindowRect
 102             specifies the position and size of the pop-up window in frame coordinates
 103      */
 104     void startPopupMode( [in] com::sun::star::awt::Rectangle WindowRect );
 105
 106
 107     /** queries the current pop-up mode
 108         @returns
 109             `TRUE` if the window is in pop-up mode
 110             `FALSE` if the window is not in pop-up mode
 111      */
 112     boolean isInPopupMode();
 113 };
 114
 115
 116 }; }; }; };
 117
 118 #endif
 119
 120 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */