diff options
Diffstat (limited to 'offapi/com/sun/star/frame/XLayoutManager.idl')
| -rw-r--r-- | offapi/com/sun/star/frame/XLayoutManager.idl | 185 |
1 files changed, 81 insertions, 104 deletions
diff --git a/offapi/com/sun/star/frame/XLayoutManager.idl b/offapi/com/sun/star/frame/XLayoutManager.idl index e6d71b822..13396ffe5 100644 --- a/offapi/com/sun/star/frame/XLayoutManager.idl +++ b/offapi/com/sun/star/frame/XLayoutManager.idl @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -28,51 +28,28 @@ #ifndef __com_sun_star_frame_XLayoutManager_idl__ #define __com_sun_star_frame_XLayoutManager_idl__ -#ifndef __com_sun_star_uno_XInterface_idl__ #include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_frame_XFrame_idl__ #include <com/sun/star/frame/XFrame.idl> -#endif - -#ifndef __com_sun_star_awt_Point_idl__ #include <com/sun/star/awt/Point.idl> -#endif - -#ifndef __com_sun_star_awt_Size_idl__ #include <com/sun/star/awt/Size.idl> -#endif - -#ifndef __com_sun_star_awt_XWindow_idl__ #include <com/sun/star/awt/XWindow.idl> -#endif - -#ifndef __com_sun_star_ui_XUIElement_idl__ #include <com/sun/star/ui/XUIElement.idl> -#endif - -#ifndef __com_sun_star_ui_DockingArea_idl__ #include <com/sun/star/ui/DockingArea.idl> -#endif - -#ifndef __com_sun_star_ui_XDockingAreaAcceptor_idl__ #include <com/sun/star/ui/XDockingAreaAcceptor.idl> -#endif -//============================================================================= +//============================================================================= module com { module sun { module star { module frame { -//============================================================================= +//============================================================================= -/** central interface to query for, create, destroy and manipulate user +/** central interface to query for, create, destroy and manipulate user interface elements which are bound to a layout manager. <p> - Every user interface element which is controlled by a layout manager has + Every user interface element which is controlled by a layout manager has a unique identifier called resource URL. - + A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. @@ -97,28 +74,28 @@ module com { module sun { module star { module frame { @since OOo 2.0 */ - -interface XLayoutManager : com::sun::star::uno::XInterface + +published interface XLayoutManager : com::sun::star::uno::XInterface { - /** attaches a <type scope="com::sun::star::frame">XFrame</type> to a layout manager. - + /** attaches a <type scope="com::sun::star::frame">XFrame</type> to a layout manager. + @param Frame specifies the frame that should be attached to the layout manager - + <p> - A layout manager needs a <type scope="com::sun::star::frame">XFrame</type> to be + A layout manager needs a <type scope="com::sun::star::frame">XFrame</type> to be able to work. Without a it no user interface elements can be created. </p> */ void attachFrame( [in] com::sun::star::frame::XFrame Frame ); - - /** resets the layout manager and remove all of its internal user interface + + /** resets the layout manager and remove all of its internal user interface elements. <p> This call should be handled with care as all user interface elements will - be destroyed and the layout manager is reseted to a state after a - <member>attachFrame</member> has been made. That means an attached frame + be destroyed and the layout manager is reseted to a state after a + <member>attachFrame</member> has been made. That means an attached frame which has been set by <member>attachFrame</member> is not released. The layout manager itself calls reset after a component has been attached or reattached to a frame. @@ -127,9 +104,9 @@ interface XLayoutManager : com::sun::star::uno::XInterface void reset(); /** provides the current docking area size of the layout manager. - + @return - The <type scope="com::sun::star::awt">Rectangle</type> contains pixel values. The + The <type scope="com::sun::star::awt">Rectangle</type> contains pixel values. The members of <type scope="com::sun::star::awt">Rectangle</type> are filled as following: <ul> <li>X = docking area on left side (in pixel)</li> @@ -140,12 +117,12 @@ interface XLayoutManager : com::sun::star::uno::XInterface */ com::sun::star::awt::Rectangle getCurrentDockingArea(); - /** retrieves the current docking area acceptor that controls the border space of the frame's + /** retrieves the current docking area acceptor that controls the border space of the frame's container window. @return current docking area acceptor which controls the border space of frame's container window. - + <p> A docking area acceptor retrieved by this method is owned by the layout manager. It is not allowed to dispose this object, it will be destroyed on reference count! @@ -157,7 +134,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface @param xDockingAreaAcceptor a docking area acceptor which controls the border space of frame's container window. - + <p> A docking area acceptor decides if the layout manager can use requested border space for docking windows. If the acceptor denies the requested space the layout manager automatically @@ -167,7 +144,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface </p> */ void setDockingAreaAcceptor( [in] com::sun::star::ui::XDockingAreaAcceptor xDockingAreaAcceptor ); - + /** creates a new user interface element. @param ResourceURL @@ -176,32 +153,32 @@ interface XLayoutManager : com::sun::star::uno::XInterface name. */ void createElement( [in] string ResourceURL ); - - /** destroys a user interface element. - + + /** destroys a user interface element. + @param ResourceURL specifies which user interface element should be destroyed. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. */ void destroyElement( [in] string ResourceURL ); - + /** request to make a user interface element visible if it is not in hidden state. @param ResourceURL specifies which user interface element should be made visible. A resource URL must - meet the following syntax: "private:resource/$type/$name". It is only allowed to use + meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return - returns <TRUE/> if the user interface element could be made visible, otherwise + returns <TRUE/> if the user interface element could be made visible, otherwise <FALSE/> will be returned. <p> - If a user interface element should forced to the visible state - <member>XLayoutManager::showElement</member> should be used. This function can be - used for context dependent elements which should respect a the current visibility + If a user interface element should forced to the visible state + <member>XLayoutManager::showElement</member> should be used. This function can be + used for context dependent elements which should respect a the current visibility state. </p> */ @@ -213,14 +190,14 @@ interface XLayoutManager : com::sun::star::uno::XInterface specifies which user interface element should be retrieved. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + <p> - The layout manager instance is owner of the returned user interface element. That means that the life time of + The layout manager instance is owner of the returned user interface element. That means that the life time of the user interface element is controlled by the layout manager. It can be disposed at every time! </p> */ com::sun::star::ui::XUIElement getElement( [in] string ResourceURL ); - + /** retrieves all user interface elements which are currently instantiated. @return @@ -228,7 +205,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface interface. <p> - The layout manager instance is owner of the returned user interface elements. That means that the life time of + The layout manager instance is owner of the returned user interface elements. That means that the life time of the user interface elements is controlled by the layout manager. They can be disposed at every time! </p> */ @@ -240,24 +217,24 @@ interface XLayoutManager : com::sun::star::uno::XInterface specifies which user interface element should be shown. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return returns <TRUE/> if the user interface element has been shown, otherwise <FALSE/> will be returned. */ boolean showElement( [in] string ResourceURL ); - + /** hides a user interface element. @param ResourceURL specifies which user interface element should be hidden. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return returns <TRUE/> if the user interface element has been hidden, otherwise <FALSE/> will be returned. */ boolean hideElement( [in] string ResourceURL ); - + /** docks a window based user interface element to a specified docking area. @param ResourceURL @@ -270,27 +247,27 @@ interface XLayoutManager : com::sun::star::uno::XInterface @param Pos specifies the position inside the docking area. - + @return returns <TRUE/> if the user interface element has been docked, otherwise <FALSE/> will be returned. @see com::sun::star::ui::DockingArea */ boolean dockWindow( [in] string ResourceURL, [in] com::sun::star::ui::DockingArea DockingArea, [in] com::sun::star::awt::Point Pos ); - + /** docks all windows which are member of the provided user interface element type. @param nElementType specifies which user interface element type should be docked. @return - returns <TRUE/> if all user interface elements of the requested type could be + returns <TRUE/> if all user interface elements of the requested type could be docked, otherwise <FALSE/> will be returned. @see com::sun::star::ui::UIElementType */ boolean dockAllWindows( [in] short nElementType ); - + /** forces a window based user interface element to float. @param ResourceURL @@ -302,7 +279,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface returns <TRUE/> if the user interface element has been docked, otherwise <FALSE/> will be returned. */ boolean floatWindow( [in] string ResourceURL ); - + /** locks a window based user interface element if it's in a docked state. @param ResourceURL @@ -319,11 +296,11 @@ interface XLayoutManager : com::sun::star::uno::XInterface @param ResourceURL specifies which user interface element should be unlocked. A resource URL must - meet the following syntax: "private:resource/$type/$name". It is only allowed + meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. @return - returns <TRUE/> if the user interface element has been unlocked, otherwise + returns <TRUE/> if the user interface element has been unlocked, otherwise <FALSE/> will be returned. */ boolean unlockWindow( [in] string ResourceURL ); @@ -344,7 +321,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface </p> */ void setElementSize( [in] string ResourceURL, [in] com::sun::star::awt::Size Size ); - + /** sets a new position for a window based user interface element. @param ResourceURL @@ -361,7 +338,7 @@ interface XLayoutManager : com::sun::star::uno::XInterface </p> */ void setElementPos( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos ); - + /** sets a new position and size for a window based user interface element. @param ResourceURL @@ -376,84 +353,84 @@ interface XLayoutManager : com::sun::star::uno::XInterface specifies the new position in pixel. <p> - It is up to the layout manager to decide if the user interface element can be moved and resized. The new position and size can + It is up to the layout manager to decide if the user interface element can be moved and resized. The new position and size can be retrieved by calling <member>getElementPos</member> and <member>getElementSize</member>. </p> */ void setElementPosSize( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos, [in] com::sun::star::awt::Size Size ); - + /** retrieves the current visibility state of a window based user interface element. @param ResourceURL - specifies for which user interface element the visibility state should be retrieved. A resource URL must meet + specifies for which user interface element the visibility state should be retrieved. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return <TRUE/> if the user interface element is visible, otherwise <FALSE/>. */ boolean isElementVisible( [in] string ResourceURL ); - + /** retrieves the current floating state of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the floating state should be retrieved. A resource URL must meet + specifies for which user interface element the floating state should be retrieved. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return <TRUE/> if the user interface element is floating, otherwise <FALSE/>. */ boolean isElementFloating( [in] string ResourceURL ); - + /** retrieves the current docking state of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the docking state should be retrieved. A resource URL must meet + specifies for which user interface element the docking state should be retrieved. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return <TRUE/> if the user interface element is docked, otherwise <FALSE/>. */ boolean isElementDocked( [in] string ResourceURL ); - + /** retrieves the current lock state of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the lock state should be retrieved. A resource URL must meet + specifies for which user interface element the lock state should be retrieved. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return <TRUE/> if the user interface element is locked, otherwise <FALSE/>. */ boolean isElementLocked( [in] string ResourceURL ); /** retrieves the current size of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the current size should be retrieved. A resource URL must meet + specifies for which user interface element the current size should be retrieved. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return the size in pixel of the user interface element. A non-window based user interface element provides a zero size. */ com::sun::star::awt::Size getElementSize( [in] string ResourceURL ); - + /** retrieves the current pixel position of a window based user interface element. - + @param ResourceURL - specifies for which user interface element the current position should be retrieved. A resource URL must meet + specifies for which user interface element the current position should be retrieved. A resource URL must meet the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. - + @return the size in pixel of the user interface element. A non-window based user interface element provides a zero size. */ com::sun::star::awt::Point getElementPos( [in] string ResourceURL ); - + /** prohibit all layout updates until unlock is called again. <p> @@ -462,25 +439,25 @@ interface XLayoutManager : com::sun::star::uno::XInterface </p> */ void lock(); - + /** permit layout updates again. - + <p> This function should be called to permit layout updates. The layout manager starts to calculate the new layout after this call. </p> */ void unlock(); - + /** forces a complete new layouting of all user interface elements. */ void doLayout(); - /** sets the layout manager to invisible state and hides all user interface elements. + /** sets the layout manager to invisible state and hides all user interface elements. <p> - A layout manager can be set to invisible state to force it to hide all of its - user interface elements. If another component wants to use the window for its + A layout manager can be set to invisible state to force it to hide all of its + user interface elements. If another component wants to use the window for its own user interface elements it can use this function. This function is normally used to implement inplace editing. </p> @@ -494,8 +471,8 @@ interface XLayoutManager : com::sun::star::uno::XInterface /** retrieves the visibility state of a layout manager. <p> - A layout manager can be set to invisible state to force it to hide all of its - user interface elements. If another component wants to use the window for its + A layout manager can be set to invisible state to force it to hide all of its + user interface elements. If another component wants to use the window for its own user interface elements it can use this function. This function is normally used to implement inplace editing. </p> |