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 :: ui ::

unpublished service ModuleWindowStateConfiguration
Usage Restrictions
not published
Description
a service which provides window based information about user interface elements of a single application module.

Every OpenOffice.org module has an amout of user interface elements that can be positioned, resized, closed and their style can be changed. This service provides access to the window based information of available user interface elements which are part of a single OpenOffice.org module, like Writer or Calc.

Since
OOo 2.0

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

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.