Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: awt ::
unpublished | interface XDockableWindowListener |
  Base Interfaces
      XDockableWindowListener
      ┗ ::com::sun::star::lang::XEventListener
  ::com::sun::star::lang::XEventListener | (referenced interface's summary:) base interface for all event listeners interfaces.
Usage Restrictions not published Description makes it possible to receive docking events.

Methods' Summary
startDocking | is invoked when the docking procedure starts.
docking | is invoked during the docking procedure when the window has been moved. on return the DockingData must contain either the old tracking rectangle or a changed rectangle if required, additionally it must indicate if the window should be docked or floating Note: the tracking rectangle indicates to the user where the window would be placed if he releases the mouse.
endDocking | is invoked when the docking procedure ends. aWindowRect contains the new position and size of the window
prepareToggleFloatingMode | is invoked when the floating mode is about to be changed between floating and docked or vice versa if returned FALSE the floating mode will not be changed
toggleFloatingMode | is invoked when the floating mode is changed between floating and docked or vice versa
closed | is invoked when the window was actively closed
endPopupMode | is invoked when the window currently is in pop-up mode and wants to be undocked or closed

Methods' Details
startDocking
void
startDocking( | [in] DockingEvent | e );
Description is invoked when the docking procedure starts.
docking
DockingData
docking( | [in] DockingEvent | e );
Description is invoked during the docking procedure when the window has been moved. on return the DockingData must contain either the old tracking rectangle or a changed rectangle if required, additionally it must indicate if the window should be docked or floating Note: the tracking rectangle indicates to the user where the window would be placed if he releases the mouse.
endDocking
void
endDocking( | [in] EndDockingEvent | e );
Description is invoked when the docking procedure ends. aWindowRect contains the new position and size of the window
prepareToggleFloatingMode
boolean
prepareToggleFloatingMode( | [in] ::com::sun::star::lang::EventObject | e );
Description is invoked when the floating mode is about to be changed between floating and docked or vice versa if returned FALSE the floating mode will not be changed
toggleFloatingMode
void
toggleFloatingMode( | [in] ::com::sun::star::lang::EventObject | e );
Description is invoked when the floating mode is changed between floating and docked or vice versa
closed
void
closed( | [in] ::com::sun::star::lang::EventObject | e );
Description is invoked when the window was actively closed
endPopupMode
void
endPopupMode( | [in] EndPopupModeEvent | e );
Description is invoked when the window currently is in pop-up mode and wants to be undocked or closed

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.