Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: 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 popupmode 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 popupmode and wants to be undocked or closed
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.