summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl')
-rw-r--r--offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl58
1 files changed, 58 insertions, 0 deletions
diff --git a/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl
new file mode 100644
index 000000000..3f9ec9b42
--- /dev/null
+++ b/offapi/com/sun/star/drawing/framework/XConfigurationChangeRequest.idl
@@ -0,0 +1,58 @@
+/* -*- 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_drawing_framework_XConfigurationChangeRequest_idl__
+#define __com_sun_star_drawing_framework_XConfigurationChangeRequest_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/drawing/framework/ConfigurationChangeEvent.idl>
+
+module com { module sun { module star { module drawing { module framework {
+
+interface XConfiguration;
+
+/** A single explicit request for a configuration change.
+
+ <p>The requested change is committed to a configuration only when the
+ execute() method is called. Configuration change
+ requests are executed asynchronously. This is done to avoid reentrance
+ problems with objects that are registered as
+ XConfigurationChangeListener and at the same time make
+ configuration change requests. When the requests were executed
+ synchronously then the listeners would be notified of the changes while
+ their request call has not yet returned.</p>
+
+ <p>This interface is typically used internally by the
+ XConfigurationController</p> @see XConfigurationController
+*/
+interface XConfigurationChangeRequest
+{
+ /** Commit the configuration change request represented by the called
+ object to the given configuration.
+ @param xConfiguration
+ This is the configuration to commit the requested change to.
+ */
+ void execute ([in] XConfiguration xConfiguration);
+};
+
+}; }; }; }; }; // ::com::sun::star::drawing::framework
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */