summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ui/XUIConfiguration.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/ui/XUIConfiguration.idl76
1 files changed, 76 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ui/XUIConfiguration.idl b/offapi/com/sun/star/ui/XUIConfiguration.idl
new file mode 100644
index 000000000..f3d419e37
--- /dev/null
+++ b/offapi/com/sun/star/ui/XUIConfiguration.idl
@@ -0,0 +1,76 @@
+/* -*- 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_XUIConfiguration_idl__
+#define __com_sun_star_ui_XUIConfiguration_idl__
+
+#include <com/sun/star/ui/XUIConfigurationListener.idl>
+
+module com { module sun { module star { module ui {
+
+/** supports to notify other implementations about changes of a user
+ interface configuration manager.
+
+ <p>
+ The XUIConfiguration interface is provided for user
+ interface configuration managers which need to broadcast changes
+ within the container; that means the actions of adding, replacing
+ and removing elements are broadcast to listeners.
+ </p>
+
+ <p>This can be useful for UI to enable/disable some functions without
+ actually accessing the data.</p>
+
+ @since OOo 2.0
+*/
+
+published interface XUIConfiguration : ::com::sun::star::uno::XInterface
+{
+ /** adds the specified listener to receive events when elements are
+ changed, inserted or removed.
+
+ <p>
+ It is suggested to allow multiple registration of the same
+ listener, thus for each time a listener is added, it has to be
+ removed.
+
+ @see XUIConfigurationListener
+ </p>
+ */
+ void addConfigurationListener( [in] ::com::sun::star::ui::XUIConfigurationListener Listener );
+
+ /** removes the specified listener so it does not receive any events
+ from this user interface configuration manager.
+
+ <p>It is suggested to allow multiple registration of the same
+ listener, thus for each time a listener is added, it has to be
+ removed.
+
+ @see XUIConfigurationListener
+ </p>
+ */
+ void removeConfigurationListener( [in] ::com::sun::star::ui::XUIConfigurationListener Listener );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */