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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_frame_FeatureStateEvent_idl__
  20 #define __com_sun_star_frame_FeatureStateEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23 #include <com/sun/star/util/URL.idl>
  24
  25
  26
  27  module com {  module sun {  module star {  module frame {
  28
  29 /** This event is broadcast by a Controller whenever the state of
  30     the feature changes
  31
  32     @see XController
  33     @see XStatusListener
  34  */
  35 published struct FeatureStateEvent: com::sun::star::lang::EventObject
  36 {
  37     /** contains the URL of the feature.
  38      */
  39     com::sun::star::util::URL FeatureURL;
  40
  41     /** contains a descriptor of the feature for the user interface.
  42      */
  43     string FeatureDescriptor;
  44
  45     /** specifies whether the feature is currently enabled or disabled.
  46      */
  47     boolean IsEnabled;
  48
  49     /** specifies whether the XDispatch has to be requeried.
  50
  51         <p>
  52         Interest code should listen for FrameActionEvent
  53         too, to update own feature states and dispatch listener on
  54         FrameAction::CONTEXT_CHANGED.
  55         </p>
  56      */
  57     boolean Requery;
  58
  59     /** contains the state of the feature in this dispatch.
  60
  61         <p>
  62         This can be, for example, simply `TRUE` for a boolean feature like
  63         underline on/off. Some simple types like <code>string</code> or
  64         `boolean` are useful here for generic UI elements, like
  65         a checkmark in a menu.
  66         </p>
  67      */
  68     any State;
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */