Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: frame ::

struct FeatureStateEvent
Base Hierarchy
FeatureStateEvent
 ┗ ::com::sun::star::lang::EventObject
Description
This event is broadcast by a Controller whenever the state of the feature changes
See also
XController, XStatusListener

Elements' Summary
FeatureURL contains the URL of the feature.  
FeatureDescriptor contains a descriptor of the feature for the user interface.  
IsEnabled specifies whether the feature is currently enabled or disabled.  
Requery specifies whether the XDispatch has to be requeried.  
State contains the state of the feature in this dispatch.  
Elements' Details
FeatureURL
::com::sun::star::util::URL FeatureURL;
Description
contains the URL of the feature.
FeatureDescriptor
string FeatureDescriptor;
Description
contains a descriptor of the feature for the user interface.
IsEnabled
boolean IsEnabled;
Description
specifies whether the feature is currently enabled or disabled.
Requery
boolean Requery;
Description
specifies whether the XDispatch has to be requeried.

Interest code should listen for FrameActionEvent too, to update own feature states and dispatch listener on FrameAction::CONTEXT_CHANGED.

State
any State;
Description
contains the state of the feature in this dispatch.

This can be, for example, simply true for a boolean feature like underline on/off. Some simple types like string or boolean are useful here for generic UI elements, like a checkmark in a menu.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.