Methods' Summary |
addDockableWindowListener |
adds a docking listener to the object.
only a single listener may be registered at any time.
|
removeDockableWindowListener |
removes the specified docking listener from the object.
|
enableDocking |
enable or disable docking, docking is disabled by default
|
isFloating |
queries the current window state
|
setFloatingMode |
toggle between floating and docked state
|
lock |
prevents the window from being undocked
this has no effect if the window is floating
|
unlock |
enables undocking
this has no effect if the window is floating
|
isLocked |
queries the current locking state
|
startPopupMode |
shows the window in a menu like style, i.e. without decoration
a special indicator will allow for tearing off the window
see com::sun::star::awt::XDockableWindowListener for
the corresponding events
|
isInPopupMode |
queries the current pop-up mode
|
Methods' Details |
addDockableWindowListener
- Description
- adds a docking listener to the object.
only a single listener may be registered at any time.
|
|
removeDockableWindowListener
- Description
- removes the specified docking listener from the object.
|
|
enableDocking
void |
enableDocking( |
[in] boolean |
bEnable ); |
- Description
- enable or disable docking, docking is disabled by default
- Parameter bEnable
- `TRUE` specifies that docking is enabled
`FALSE` specifies that docking is disabled and no
com::sun::star::awt::XDockableWindowListener will be called
|
|
isFloating
- Description
- queries the current window state
- Returns
- `TRUE` if the window is floating
`FALSE` if the window is docked
|
|
setFloatingMode
void |
setFloatingMode( |
[in] boolean |
bFloating ); |
- Description
- toggle between floating and docked state
- Parameter bFloating
- specifies the new floating mode:
`TRUE` means floating, `FALSE` means docked
|
|
lock
- Description
- prevents the window from being undocked
this has no effect if the window is floating
|
|
unlock
- Description
- enables undocking
this has no effect if the window is floating
|
|
isLocked
- Description
- queries the current locking state
- Returns
- `TRUE` if the window is locked
`FALSE` if the window is not locked
|
|
startPopupMode
void |
startPopupMode( |
[in] Rectangle |
WindowRect ); |
- Description
- shows the window in a menu like style, i.e. without decoration
a special indicator will allow for tearing off the window
see com::sun::star::awt::XDockableWindowListener for
the corresponding events
- Parameter WindowRect
- specifies the position and size of the pop-up window in frame coordinates
|
|
isInPopupMode
- Description
- queries the current pop-up mode
- Returns
- `TRUE` if the window is in pop-up mode
`FALSE` if the window is not in pop-up mode
|
|
Copyright © 2020, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.