struct FeatureStateEvent in module com::sun::star::frame::

(Global Index)

Syntax

struct FeatureStateEvent : com::sun::star::lang::EventObject ;

Description

This event is broadcast by a Controller whenever the state of the feature changes.

See also

XController

See also

XStatusListener

Field 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.

Field Details



FeatureURL

Syntax

com::sun::star::util::URL FeatureURL;

Description

contains the URL of the feature.


FeatureDescriptor

Syntax

string FeatureDescriptor;

Description

contains a descriptor of the feature for the user interface.


IsEnabled

Syntax

boolean IsEnabled;

Description

specifies whether the feature is currently enabled or disabled.


Requery

Syntax

boolean Requery;

Description

specifies whether the XDispatch has to be requeried.


State

Syntax

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