:: com :: sun :: star :: ui ::

service ModuleWindowStateConfiguration

Exported Interfaces - Summary
::com::sun::star::container::XNameContainer

provides read/write access to window based information of user interface elements which are part of single installed module. (details)

Exported Interfaces - Details
::com::sun::star::container::XNameContainer
Description
provides read/write access to window based information of user interface elements which are part of single installed module.

An implementation must provide a com::sun::star::uno::Sequence which has ::com::sun::star::beans::PropertyValue as entries. The following entries a defined:

  • Docked
    a boolean which specifies if the window is docked or not.
  • DockingArea
    a DockingArea which specifies the docking area where the window is docked.
  • DockPos
    a ::com::sun::star::awt::Point which specifies the docked position of a window. The X and Y values are interpreted as a row/column number and a pixel position for top/bottom docked windows. For left/right docked windows this is
  • DockSize
    a ::com::sun::star::awt::Size which specifies the docked size of the window. This property is currently not used by the layout manager implementation. For future use.
  • Locked
    a boolean which specifies if the window is locked or not. This property is only valid for docked windows
  • Pos
    a ::com::sun::star::awt::Point which specifies the floating position in pixel of the window.
  • Size
    a ::com::sun::star::awt::Size which specifies the floating size in pixel of the window.
  • Style
    a long which specifies the style of the window. A toolbar support the following values: 0 = icons, 1 = text, 2 = text+icons.
  • UIName

    a localized string which specifies the default window title.
The key to a user interface element is the resource URL which has the following syntax "private:resource/$type/$name". For example "private:resource/toolbar/standardbar" addresses the standard bar of a module. A complete list of all user interface elements is available in the Developers Guide.

See also
::com::sun::star::frame::ModuleManager

 
Top of Page