1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_frame_FeatureStateEvent_idl__
24#define __com_sun_star_frame_FeatureStateEvent_idl__
25
26#ifndef __com_sun_star_lang_EventObject_idl__
27#include <com/sun/star/lang/EventObject.idl>
28#endif
29
30#ifndef __com_sun_star_util_URL_idl__
31#include <com/sun/star/util/URL.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module frame {
38
39//=============================================================================
40/** This event is broadcast by a <type>Controller</type> whenever the state of
41    the feature changes
42
43    @see XController
44    @see XStatusListener
45 */
46published struct FeatureStateEvent: com::sun::star::lang::EventObject
47{
48	//-------------------------------------------------------------------------
49	/** contains the URL of the feature.
50	 */
51	com::sun::star::util::URL FeatureURL;
52
53	//-------------------------------------------------------------------------
54	/** contains a descriptor of the feature for the user interface.
55	 */
56	string FeatureDescriptor;
57
58	//-------------------------------------------------------------------------
59	/** specifies whether the feature is currently enabled or disabled.
60	 */
61	boolean IsEnabled;
62
63	//-------------------------------------------------------------------------
64	/** specifies whether the <type>XDispatch</type> has to be requeried.
65
66        <p>
67        Interest code should listen for <type>FrameActionEvent</type>
68        too, to update own feature states and dispatch listener on
69        <const>FrameAction::CONTEXT_CHANGED</const>.
70        </p>
71	 */
72	boolean Requery;
73
74	//-------------------------------------------------------------------------
75	/** contains the state of the feature in this dispatch.
76
77        <p>
78        This can be, for example, simply <TRUE/> for a boolean feature like
79		underline on/off. Some simple types like <code>string</code> or
80		<atom>boolean</atom> are useful here for generic UI elements, like
81        a checkmark in a menu.
82        </p>
83	 */
84	any State;
85};
86
87//=============================================================================
88
89}; }; }; };
90
91#endif
92