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 :: ui ::

interface XDockingAreaAcceptor
Description
this interface enables developer to implement different docking area acceptors which are used by the frame based layout manager.

A docking area acceptor is responsible to control the docking area of a container window. As OLE for example supports inplace and outplace editing, there are different parts of code responsible for the container window. This interface enables developer to make support implementations for these scenarios.

Since
OOo 2.0
See also
::com::sun::star::frame::XFrame


Methods' Summary
getContainerWindow provide the container window where the layout manager can request border space for docking windows.  
requestDockingAreaSpace method to ask an implementation if the provided space for docking windows is available or not.  
setDockingAreaSpace method to brief an implementation that we need new border space.  
Methods' Details
getContainerWindow
::com::sun::star::awt::XWindow
getContainerWindow();

Description
provide the container window where the layout manager can request border space for docking windows.

Additionally the layout manager uses this window to create its own child windows for docking purposes.

requestDockingAreaSpace
boolean
requestDockingAreaSpace( [in] ::com::sun::star::awt::Rectangle  RequestedSpace );

Description
method to ask an implementation if the provided space for docking windows is available or not.

The ::com::sun::star::awt::Rectangle parameter is filled by the caller with pixel data. The members of ::com::sun::star::awt::Rectangle must be filled as following:

  • X = requested area on left side (in pixel)
  • Y = requested area on top side (in pixel)
  • Width = requested area on right side (in pixel)
  • Height = requested area on bottom side (in pixel)

setDockingAreaSpace
void
setDockingAreaSpace( [in] ::com::sun::star::awt::Rectangle  BorderSpace );

Description
method to brief an implementation that we need new border space.

The callee must size its document window so that we have the amount of space we have provided. The ::com::sun::star::awt::Rectangle parameter is filled by the caller with pixel data. The members of ::com::sun::star::awt::Rectangle must be filled as following:

  • X = new area on left side (in pixel)
  • Y = new area on top side (in pixel)
  • Width = new area on right side (in pixel)
  • Height = new area on bottom side (in pixel)

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.