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

interface XUIElementSettings
Description
provides functions to retrieve and change user interface element structure data and to update its visible representation.
Since
OOo 2.0

Methods' Summary
updateSettings forces the user interface element to retrieve new settings from its configuration source.  
getSettings provides a UIElementSettings instance that provides access to the structure of user interface element if the user interface element type supports it.  
setSettings set changes to the structure of the user interface element.  
Methods' Details
updateSettings
void
updateSettings();

Description
forces the user interface element to retrieve new settings from its configuration source.

This is not done automatically as configurable user interface elements are controlled by layout managers. It is more efficient to let the responsible layout manager to control the update process in a single task.

getSettings
::com::sun::star::container::XIndexAccess
getSettings( [in] boolean  bWriteable );

Description
provides a UIElementSettings instance that provides access to the structure of user interface element if the user interface element type supports it.
Parameter bWriteable
must be true if the retrieved settings should be a writeable. Otherwise false should be provided to get a shareable reference to the settings data.
Returns
the current settings of the user interface element.
setSettings
void
setSettings( [in] ::com::sun::star::container::XIndexAccess  UISettings );

Description
set changes to the structure of the user interface element.
Parameter UISettings
new data settings for the configurable user interface element.

User interface elements cannot be changed directly. The changed structure data has to be set again. This speeds up the configuration process if many changes have to be made on the structure. The persistence of changes are controlled by the boolean property Persistent.

See also
UIElementSettings
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.