From 524eb018927b727f1a90c78639295ac93a63a0c7 Mon Sep 17 00:00:00 2001 From: Rüdiger Timm Date: Wed, 30 Jul 2008 13:27:26 +0000 Subject: INTEGRATION: CWS layoutdialogs (1.2.26); FILE MERGED 2008/04/07 19:41:46 cl 1.2.26.1: removed the publish tag and fine tuned some descriptions --- offapi/com/sun/star/awt/MaxChildrenException.idl | 4 +++- offapi/com/sun/star/awt/XDialog2.idl | 7 +++++- offapi/com/sun/star/awt/XLayoutContainer.idl | 30 +++++++++++++++++------- 3 files changed, 31 insertions(+), 10 deletions(-) (limited to 'offapi/com/sun/star/awt') diff --git a/offapi/com/sun/star/awt/MaxChildrenException.idl b/offapi/com/sun/star/awt/MaxChildrenException.idl index 88c9601f6..3fb7d9073 100644 --- a/offapi/com/sun/star/awt/MaxChildrenException.idl +++ b/offapi/com/sun/star/awt/MaxChildrenException.idl @@ -15,8 +15,10 @@ module com { module sun { module star { module awt { @see XLayoutContainer @see com::sun::star::awt::XLayoutContainer::addChild + + @since OOo 3.0 */ -published exception MaxChildrenException: com::sun::star::uno::Exception +exception MaxChildrenException: com::sun::star::uno::Exception { }; diff --git a/offapi/com/sun/star/awt/XDialog2.idl b/offapi/com/sun/star/awt/XDialog2.idl index a9b99dc26..70aafbc00 100644 --- a/offapi/com/sun/star/awt/XDialog2.idl +++ b/offapi/com/sun/star/awt/XDialog2.idl @@ -13,9 +13,14 @@ module com { module sun { module star { module awt { //============================================================================= /** Makes it possible to end a dialog. + + @since OOo 3.0 */ -published interface XDialog2: com::sun::star::awt::XDialog +interface XDialog2: com::sun::star::awt::XDialog { + /** hides the dialog and then causes XDialog::execute + to return with the given result value. + */ void endDialog ( [in] long Result ); }; diff --git a/offapi/com/sun/star/awt/XLayoutContainer.idl b/offapi/com/sun/star/awt/XLayoutContainer.idl index 2f400de96..edee6681a 100644 --- a/offapi/com/sun/star/awt/XLayoutContainer.idl +++ b/offapi/com/sun/star/awt/XLayoutContainer.idl @@ -26,45 +26,59 @@ module com { module sun { module star { module awt { //============================================================================= -published interface XLayoutUnit; +interface XLayoutUnit; /** specifies the layout constraints for a surrounding container. + + @since OOo 3.0 */ -published interface XLayoutContainer: com::sun::star::container::XChild +interface XLayoutContainer: com::sun::star::container::XChild { - /* Add/remove a child. Some containers provide an interface for + /** Adds a child. Some containers provide an interface for adding children which you should use. */ void addChild( [in] com::sun::star::awt::XLayoutConstrains Child ) raises( com::sun::star::awt::MaxChildrenException ); + + /** Remove a child. Some containers provide an interface for + adding children which you should use. + */ void removeChild( [in] com::sun::star::awt::XLayoutConstrains Child ); + + /** Returns a sequence of the children of this container. */ sequence< com::sun::star::awt::XLayoutConstrains > getChildren(); - /* Read/modify some child layout properties. XPropertySet provides a + /** 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. */ com::sun::star::beans::XPropertySet getChildProperties( [in] com::sun::star::awt::XLayoutConstrains Child ); - /* Set at initilization, this object should be notified when a containers state + /** Set at initilization, this object should be notified when a containers state changes, that may affect its size, to queue a layout re-calculation. */ void setLayoutUnit( [in] com::sun::star::awt::XLayoutUnit Unit ); // TEMP: no need for this... com::sun::star::awt::XLayoutUnit getLayoutUnit(); - /* To be used by the parent for the purpose of layout management. + /** To be used by the parent for the purpose of layout management. For widgets, use XWindow::setPosSize() */ void allocateArea( [in] com::sun::star::awt::Rectangle NewArea ); - /* Used by the layouting unit to evaluate size damage, and force a + /** Used by the layouting unit to evaluate size damage, and force a re-allocation. */ com::sun::star::awt::Size getRequestedSize(); + + /** Used by the layouting unit to evaluate size damage, and force a + re-allocation. */ com::sun::star::awt::Rectangle getAllocatedArea(); - /* For flow layouting (e.g. wrap-able labels). TODO: We might want to + /** For flow layouting (e.g. wrap-able labels). TODO: We might want to re-design this approach -- check XLayoutConstrains::calcAdjustedSize(). */ long getHeightForWidth( [in] long Width ); + + /** For flow layouting (e.g. wrap-able labels). TODO: We might want to + re-design this approach -- check XLayoutConstrains::calcAdjustedSize(). */ boolean hasHeightForWidth(); }; -- cgit v1.2.3