1 files changed, 88 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/XUIElementSettings.idl b/offapi/com/sun/star/ui/XUIElementSettings.idl
new file mode 100644
index 000000000..3d0a7b105
--- /dev/null
+++ b/offapi/com/sun/star/ui/XUIElementSettings.idl
@@ -0,0 +1,88 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_ui_XUIElementSettings_idl__
+#define __com_sun_star_ui_XUIElementSettings_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/container/XIndexAccess.idl>
+
+
+module com { module sun { module star { module ui {
+
+
+/** provides functions to retrieve and change user interface element structure
+    data and to update its visible representation.
+
+    @since OOo 2.0
+*/
+
+interface XUIElementSettings : com::sun::star::uno::XInterface
+{
+    /** forces the user interface element to retrieve new settings from its
+        configuration source.
+
+        <p>
+        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.
+        </p>
+    */
+    void updateSettings();
+
+    /** provides a UIElementSettings instance that provides access
+        to the structure of user interface element if the user interface element
+        type supports it.
+
+        @param 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.
+
+        @return
+            the current settings of the user interface element.
+    */
+    com::sun::star::container::XIndexAccess getSettings( [in] boolean bWriteable );
+
+    /** set changes to the structure of the user interface element.
+
+        @param UISettings
+            new data settings for the configurable user interface element.
+
+
+        <p>
+        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.
+
+        </p>
+
+        @see com::sun::star::ui::UIElementSettings
+    */
+    void setSettings( [in] com::sun::star::container::XIndexAccess UISettings );
+};
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */