LibreOffice
LibreOffice 24.2 SDK API Reference
Loading...
Searching...
No Matches
XLayoutManager2 Interface Reference

Unified interface for LayoutManager service. More...

import <XLayoutManager2.idl;

Inheritance diagram for XLayoutManager2:
XLayoutManager XFrameActionListener XUIConfigurationListener XMenuBarMergingAcceptor XLayoutManagerEventBroadcaster XInterface XEventListener XEventListener XInterface XInterface XInterface XInterface LayoutManager

Exported Interfaces

interface ::com::sun::star::frame::XLayoutManager
 central interface to query for, create, destroy and manipulate user interface elements which are bound to a frame.
 
interface ::com::sun::star::frame::XFrameActionListener
 notification interface to receive status information about the state of the connected frame.
 
interface ::com::sun::star::ui::XUIConfigurationListener
 notification interface to receive change messages of user interface elements which are part of the layout manager.
 
interface ::com::sun::star::frame::XMenuBarMergingAcceptor
 provides functions to merge menus for inplace editing of components inside OpenOffice.org.
 
interface ::com::sun::star::frame::XLayoutManagerEventBroadcaster
 registers listeners that want to receive layout manager events.
 

Additional Inherited Members

- Public Member Functions inherited from XLayoutManager
void attachFrame ([in] com::sun::star::frame::XFrame Frame)
 attaches a com::sun::star::frame::XFrame to a layout manager.
 
void reset ()
 resets the layout manager and remove all of its internal user interface elements.
 
com::sun::star::awt::Rectangle getCurrentDockingArea ()
 provides the current docking area size of the layout manager.
 
com::sun::star::ui::XDockingAreaAcceptor getDockingAreaAcceptor ()
 retrieves the current docking area acceptor that controls the border space of the frame's container window.
 
void setDockingAreaAcceptor ([in] com::sun::star::ui::XDockingAreaAcceptor xDockingAreaAcceptor)
 sets a docking area acceptor that controls the border space of the frame's container window.
 
void createElement ([in] string ResourceURL)
 creates a new user interface element.
 
void destroyElement ([in] string ResourceURL)
 destroys a user interface element.
 
boolean requestElement ([in] string ResourceURL)
 request to make a user interface element visible if it is not in hidden state.
 
com::sun::star::ui::XUIElement getElement ([in] string ResourceURL)
 retrieves a user interface element which has been created before.
 
sequence< com::sun::star::ui::XUIElementgetElements ()
 retrieves all user interface elements which are currently instantiated.
 
boolean showElement ([in] string ResourceURL)
 shows a user interface element.
 
boolean hideElement ([in] string ResourceURL)
 hides a user interface element.
 
boolean dockWindow ([in] string ResourceURL, [in] com::sun::star::ui::DockingArea DockingArea, [in] com::sun::star::awt::Point Pos)
 docks a window based user interface element to a specified docking area.
 
boolean dockAllWindows ([in] short nElementType)
 docks all windows which are member of the provided user interface element type.
 
boolean floatWindow ([in] string ResourceURL)
 forces a window based user interface element to float.
 
boolean lockWindow ([in] string ResourceURL)
 locks a window based user interface element if it's in a docked state.
 
boolean unlockWindow ([in] string ResourceURL)
 unlocks a window based user interface element if it's in a docked state.
 
void setElementSize ([in] string ResourceURL, [in] com::sun::star::awt::Size Size)
 sets a new size for a window based user interface element.
 
void setElementPos ([in] string ResourceURL, [in] com::sun::star::awt::Point Pos)
 sets a new position for a window based user interface element.
 
void setElementPosSize ([in] string ResourceURL, [in] com::sun::star::awt::Point Pos, [in] com::sun::star::awt::Size Size)
 sets a new position and size for a window based user interface element.
 
boolean isElementVisible ([in] string ResourceURL)
 retrieves the current visibility state of a window based user interface element.
 
boolean isElementFloating ([in] string ResourceURL)
 retrieves the current floating state of a window based user interface element.
 
boolean isElementDocked ([in] string ResourceURL)
 retrieves the current docking state of a window based user interface element.
 
boolean isElementLocked ([in] string ResourceURL)
 retrieves the current lock state of a window based user interface element.
 
com::sun::star::awt::Size getElementSize ([in] string ResourceURL)
 retrieves the current size of a window based user interface element.
 
com::sun::star::awt::Point getElementPos ([in] string ResourceURL)
 retrieves the current pixel position of a window based user interface element.
 
void lock ()
 prohibit all layout updates until unlock is called again.
 
void unlock ()
 permit layout updates again.
 
void doLayout ()
 forces a complete new layouting of all user interface elements.
 
void setVisible ([in] boolean Visible)
 sets the layout manager to invisible state and hides all user interface elements.
 
boolean isVisible ()
 retrieves the visibility state of a layout manager.
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object.
 
void acquire ()
 increases the reference counter by one.
 
void release ()
 decreases the reference counter by one.
 
- Public Member Functions inherited from XFrameActionListener
void frameAction ([in] FrameActionEvent Action)
 is called whenever any action occurs to a component within a frame.
 
- Public Member Functions inherited from XEventListener
void disposing ([in] com::sun::star::lang::EventObject Source)
 gets called when the broadcaster is about to be disposed.
 
- Public Member Functions inherited from XUIConfigurationListener
void elementInserted ([in] ::com::sun::star::ui::ConfigurationEvent Event)
 is invoked when a configuration has inserted an user interface element.
 
void elementRemoved ([in] ::com::sun::star::ui::ConfigurationEvent Event)
 is invoked when a configuration has removed an user interface element.
 
void elementReplaced ([in] ::com::sun::star::ui::ConfigurationEvent Event)
 is invoked when a configuration has replaced an user interface element.
 
- Public Member Functions inherited from XMenuBarMergingAcceptor
boolean setMergedMenuBar ([in] ::com::sun::star::container::XIndexAccess xMergedMenuBar)
 allows to set a merged menu bar.
 
void removeMergedMenuBar ()
 removes a previously set merged menu bar and sets a previously created menu bar back.
 
- Public Member Functions inherited from XLayoutManagerEventBroadcaster
void addLayoutManagerEventListener ([in] XLayoutManagerListener aLayoutManagerListener)
 adds a layout manager event listener to the object's listener list.
 
void removeLayoutManagerEventListener ([in] XLayoutManagerListener aLayoutManagerListener)
 removes a layout manager event listener from the object's listener list.
 

Detailed Description

Unified interface for LayoutManager service.

Since
LibreOffice 4.2

Exported Interfaces

◆ ::com::sun::star::frame::XFrameActionListener

notification interface to receive status information about the state of the connected frame.

E.g., you can receive events of instantiation/destruction and activation/deactivation of a frame.

See also
XFrame::addFrameActionListener()
XFrame::removeFrameActionListener()

◆ ::com::sun::star::frame::XLayoutManager

central interface to query for, create, destroy and manipulate user interface elements which are bound to a frame.

See also
com::sun::star::frame::XLayoutManager;

◆ ::com::sun::star::frame::XLayoutManagerEventBroadcaster

registers listeners that want to receive layout manager events.

◆ ::com::sun::star::frame::XMenuBarMergingAcceptor

provides functions to merge menus for inplace editing of components inside OpenOffice.org.

◆ ::com::sun::star::ui::XUIConfigurationListener

notification interface to receive change messages of user interface elements which are part of the layout manager.

E.g., you can receive events of insertion/replacing and removing of settings data of user interface elements.

See also
com::sun::star::ui::XUIConfiguration

The documentation for this interface was generated from the following file: