offapi/com/sun/star/frame/FeatureStateEvent.idl

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