1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_frame_FeatureStateEvent_idl__
28#define __com_sun_star_frame_FeatureStateEvent_idl__
29
30#ifndef __com_sun_star_lang_EventObject_idl__
31#include <com/sun/star/lang/EventObject.idl>
32#endif
33
34#ifndef __com_sun_star_util_URL_idl__
35#include <com/sun/star/util/URL.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module frame {
42
43//=============================================================================
44/** This event is broadcast by a <type>Controller</type> whenever the state of
45    the feature changes
46
47    @see XController
48    @see XStatusListener
49 */
50published struct FeatureStateEvent: com::sun::star::lang::EventObject
51{
52	//-------------------------------------------------------------------------
53	/** contains the URL of the feature.
54	 */
55	com::sun::star::util::URL FeatureURL;
56
57	//-------------------------------------------------------------------------
58	/** contains a descriptor of the feature for the user interface.
59	 */
60	string FeatureDescriptor;
61
62	//-------------------------------------------------------------------------
63	/** specifies whether the feature is currently enabled or disabled.
64	 */
65	boolean IsEnabled;
66
67	//-------------------------------------------------------------------------
68	/** specifies whether the <type>XDispatch</type> has to be requeried.
69
70        <p>
71        Interest code should listen for <type>FrameActionEvent</type>
72        too, to update own feature states and dispatch listener on
73        <const>FrameAction::CONTEXT_CHANGED</const>.
74        </p>
75	 */
76	boolean Requery;
77
78	//-------------------------------------------------------------------------
79	/** contains the state of the feature in this dispatch.
80
81        <p>
82        This can be, for example, simply <TRUE/> for a boolean feature like
83		underline on/off. Some simple types like <code>string</code> or
84		<atom>boolean</atom> are useful here for generic UI elements, like
85        a checkmark in a menu.
86        </p>
87	 */
88	any State;
89};
90
91//=============================================================================
92
93}; }; }; };
94
95#endif
96