LibreOffice Module framework (master) 1
XDesktop Interface Reference

try to shutdown these desktop environment. More...

#include <desktop.hxx>

Detailed Description

try to shutdown these desktop environment.

remove a listener from this container.

add a listener for termination events

@descr Will try to close all frames. If at least one frame could not be closed successfully termination will be stopped.

Registered termination listener will be taken into account also. As special feature some of our registered listener are well known by its UNO implementation name. They are handled different to all other listener.

Btw: Desktop.terminate() was designed in the past to be used within an UI based environment. So it's allowed e.g. to call XController.suspend() here. If UI isn't an option ... please use XCloseable.close() at these desktop implementation. ... if it will be supported in the future .-))

@seealso XTerminateListener @seealso XTerminateListener2

Returns
true if all open frames could be closed and no listener threw a veto exception; false otherwise.

@onerror False will be returned. @threadsafe yes

@descr Additional to adding normal listener these method was implemented special. Every listener will be asked for its uno implementation name. Some of them are well known... and the corresponding listener won't be added to the container of "normal listener". Those listener will be set as special member. see e.g. member m_xSfxTerminator

@seealso terminate()

Parameters
xListenerthe listener for registration.

@threadsafe yes

@descr Additional to removing normal listener these method was implemented special. Every listener will be asked for its uno implementation name. Some of them are well known... and the corresponding listener was set as special member. Now those special member will be reset also. see e.g. member m_xSfxTerminator

@seealso terminate()

Parameters
xListenerthe listener for deregistration.

@threadsafe yes


The documentation for this interface was generated from the following file: