(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.

:: com :: sun :: star :: embed ::

interface XStateChangeListener
Base Interfaces
XStateChangeListener
┗ ::com::sun::star::lang::XEventListener

::com::sun::star::lang::XEventListener
(referenced interface's summary:)
base interface for all event listeners interfaces.
Description
makes it possible to receive events when an embedded object changes it's state.

Methods' Summary
changingState is called just before the object changes state.  
stateChanged is called after the object has changed state.  
Methods' Details
changingState
void
changingState( [in] ::com::sun::star::lang::EventObject  aEvent,
[in] long  nOldState,
[in] long  nNewState )
raises( WrongStateException );

Description
is called just before the object changes state.

Actually the listener can try to complain about state changing, but it is up to object to decide whether the state change can be prevented. Anyway the possibility to complain must be used very carefully.

Parameter aEvent
specifies the object that is going to change own state
Parameter nOldState
specifies the old state of the object
Parameter nNewState
specifies the new state of the object
Throws
::com::sun::star::embed::WrongStateException the state change is unexpected by listener
stateChanged
void
stateChanged( [in] ::com::sun::star::lang::EventObject  aEvent,
[in] long  nOldState,
[in] long  nNewState );

Description
is called after the object has changed state.
Parameter aEvent
specifies the object that has changed own state
Parameter nOldState
specifies the old state of the object
Parameter nNewState
specifies the new state of the object
Top of Page

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.