Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

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

::com::sun::star::lang::XEventListener
(referenced interface's summary:)
base interface for all event listeners interfaces.
Description
has to be provided if an object wants to receive an event when the master environment (e.g., desktop) is terminated.
See also
XDesktop::terminate(), XDesktop::addTerminateListener(), XDesktop::removeTerminateListener()

Methods' Summary
queryTermination is called when the master environment (e.g., desktop) is about to terminate.  
notifyTermination is called when the master environment is finally terminated. Not veto will be accepted then.  
Methods' Details
queryTermination
void
queryTermination( [in] ::com::sun::star::lang::EventObject  Event )
raises( TerminationVetoException );

Description
is called when the master environment (e.g., desktop) is about to terminate.

Termination can be intercepted by throwing TerminationVetoException. Interceptor will be the new owner of desktop and should call XDesktop::terminate() after finishing his own operations.

Parameter Event
describe the source of the event (e.g., the desktop)
Throws
TerminationVetoException listener can disagree with this query by throwing this veto exception
notifyTermination
void
notifyTermination( [in] ::com::sun::star::lang::EventObject  Event );

Description
is called when the master environment is finally terminated. Not veto will be accepted then.
Parameter Event
describe the source of the event (e.g., the desktop)
Top of Page

Apache Software Foundation

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

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