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 XLayoutContainer
Base Interfaces
XLayoutContainer
┗ ::com::sun::star::container::XChild

::com::sun::star::container::XChild
(referenced interface's summary:)
provides access to the parent of the object.
Usage Restrictions
not published
Description
specifies the layout constraints for a surrounding container.
Since
OOo 3.0

Methods' Summary
addChild Adds a child. Some containers provide an interface for adding children which you should use.  
removeChild Remove a child. Some containers provide an interface for adding children which you should use.  
getChildren Returns a sequence of the children of this container.  
getChildProperties Read/modify some child layout properties. XPropertySet provides a rich API that allows, e.g., for introspection. Should rarely be a need to use; containers shall provide an interface for setting properties more confortably.  
setLayoutUnit Set at initilization, this object should be notified when a containers state changes, that may affect its size, to queue a layout re-calculation.  
getLayoutUnit  
allocateArea To be used by the parent for the purpose of layout management. For widgets, use XWindow::setPosSize()  
getRequestedSize Used by the layouting unit to evaluate size damage, and force a re-allocation.  
getAllocatedArea Used by the layouting unit to evaluate size damage, and force a re-allocation.  
getHeightForWidth For flow layouting (e.g. wrap-able labels). TODO: We might want to re-design this approach -- check XLayoutConstrains::calcAdjustedSize().  
hasHeightForWidth For flow layouting (e.g. wrap-able labels). TODO: We might want to re-design this approach -- check XLayoutConstrains::calcAdjustedSize().  
Methods' Details
addChild
void
addChild( [in] XLayoutConstrains  Child )
raises( MaxChildrenException );

Description
Adds a child. Some containers provide an interface for adding children which you should use.
removeChild
void
removeChild( [in] XLayoutConstrains  Child );

Description
Remove a child. Some containers provide an interface for adding children which you should use.
getChildren
sequence< XLayoutConstrains >
getChildren();

Description
Returns a sequence of the children of this container.
getChildProperties
::com::sun::star::beans::XPropertySet
getChildProperties( [in] XLayoutConstrains  Child );

Description
Read/modify some child layout properties. XPropertySet provides a rich API that allows, e.g., for introspection. Should rarely be a need to use; containers shall provide an interface for setting properties more confortably.
setLayoutUnit
void
setLayoutUnit( [in] XLayoutUnit  Unit );

Description
Set at initilization, this object should be notified when a containers state changes, that may affect its size, to queue a layout re-calculation.
getLayoutUnit
XLayoutUnit
getLayoutUnit();

allocateArea
void
allocateArea( [in] Rectangle  NewArea );

Description
To be used by the parent for the purpose of layout management. For widgets, use XWindow::setPosSize()
getRequestedSize
Size
getRequestedSize();

Description
Used by the layouting unit to evaluate size damage, and force a re-allocation.
getAllocatedArea
Rectangle
getAllocatedArea();

Description
Used by the layouting unit to evaluate size damage, and force a re-allocation.
getHeightForWidth
long
getHeightForWidth( [in] long  Width );

Description
For flow layouting (e.g. wrap-able labels). TODO: We might want to re-design this approach -- check XLayoutConstrains::calcAdjustedSize().
hasHeightForWidth
boolean
hasHeightForWidth();

Description
For flow layouting (e.g. wrap-able labels). TODO: We might want to re-design this approach -- check XLayoutConstrains::calcAdjustedSize().
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.