summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/frame/FeatureStateEvent.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/frame/FeatureStateEvent.idl')
-rw-r--r--offapi/com/sun/star/frame/FeatureStateEvent.idl76
1 files changed, 76 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl
new file mode 100644
index 000000000..026341239
--- /dev/null
+++ b/offapi/com/sun/star/frame/FeatureStateEvent.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_frame_FeatureStateEvent_idl__
+#define __com_sun_star_frame_FeatureStateEvent_idl__
+
+#include <com/sun/star/lang/EventObject.idl>
+#include <com/sun/star/util/URL.idl>
+
+
+
+ module com { module sun { module star { module frame {
+
+/** This event is broadcast by a Controller whenever the state of
+ the feature changes
+
+ @see XController
+ @see XStatusListener
+ */
+published struct FeatureStateEvent: com::sun::star::lang::EventObject
+{
+ /** contains the URL of the feature.
+ */
+ com::sun::star::util::URL FeatureURL;
+
+ /** contains a descriptor of the feature for the user interface.
+ */
+ string FeatureDescriptor;
+
+ /** specifies whether the feature is currently enabled or disabled.
+ */
+ boolean IsEnabled;
+
+ /** specifies whether the XDispatch has to be required.
+
+ <p>
+ Interest code should listen for FrameActionEvent
+ too, to update own feature states and dispatch listener on
+ FrameAction::CONTEXT_CHANGED.
+ </p>
+ */
+ boolean Requery;
+
+ /** contains the state of the feature in this dispatch.
+
+ <p>
+ This can be, for example, simply `TRUE` for a boolean feature like
+ underline on/off. Some simple types like <code>string</code> or
+ `boolean` are useful here for generic UI elements, like
+ a checkmark in a menu.
+ </p>
+ */
+ any State;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */