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