LibreOffice
LibreOffice 6.4 SDK API Reference
Exported Interfaces | List of all members
ModuleWindowStateConfiguration Service Reference

a service which provides window based information about user interface elements of a single application module. More...

import"ModuleWindowStateConfiguration.idl";

Inheritance diagram for ModuleWindowStateConfiguration:
XNameContainer XNameReplace XNameAccess XElementAccess XInterface

Exported Interfaces

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

Additional Inherited Members

- Public Member Functions inherited from XNameContainer
void insertByName ([in] string aName, [in] any aElement) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException, com::sun::star::lang::WrappedTargetException )
 inserts the given element at the specified name. More...
 
void removeByName ([in] string Name) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 removes the element with the specified name. More...
 
- Public Member Functions inherited from XNameReplace
void replaceByName ([in] string aName, [in] any aElement) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 replaces the element with the specified name with the given element. More...
 
- Public Member Functions inherited from XNameAccess
any getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
sequence< string > getElementNames ()
 
boolean hasByName ([in] string aName)
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

a service which provides window based information about user interface elements of a single application module.

Every OpenOffice.org module has an amount 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

◆ com::sun::star::container::XNameContainer

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 com::sun::star::ui::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

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