Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: ui ::
unpublished | interface XUIElementSettings |
Usage Restrictions not published 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 writable. 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

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.