Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: util ::
interface XCloseListener
  Base Interfaces
      XCloseListener
      ┗ ::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 object is called for closing Such close events are broadcasted by a XCloseBroadcaster if somewhere tries to close it by calling XCloseable::close(). Listener can: break that by throwing CloseVetoException or accept that by deregister himself at this broadcaster. If an event XEventListener::disposing occurred, nobody called XCloseable::close on listened object before. Then it's not allowed to break this request - it must be accepted! See also XCloseable, XCloseBroadcaster Developers Guide OfficeDev - Closing Documents

Methods' Summary
queryClosing | is called when somewhere tries to close listened object
notifyClosing | is called when the listened object is closed really

Methods' Details
queryClosing
void
queryClosing( | [in] ::com::sun::star::lang::EventObject | Source,
| [in] boolean | GetsOwnership )
raises( | CloseVetoException );
Description is called when somewhere tries to close listened object Is called before XCloseListener::notifyClosing(). Listener has the chance to break that by throwing a CloseVetoException. This exception must be passed to the original caller of XCloseable::close() without any interaction. The parameter GetsOwnership regulate who has to try to close the listened object again, if this listener disagree with the request by throwing the exception. If it's set to false the original caller of XCloseable::close() will be the owner in every case. It's not allowed to call close() from this listener then. If it's set to true this listener will be the new owner if he throw the exception, otherwise not! If his still running processes will be finished he must call close() on listened object again then. If this listener doesn't disagree with th close request it depends from his internal implementation if he deregister himself at the listened object. But normally this must be done in XCloseListener::notifyClosing(). Parameter Source describes the source of the event (must be the listened object) Parameter GetsOwnership true pass the ownership to this listener, if he throw the veto exception (otherwise this parameter must be ignored!) false forbids to grab the ownership for the listened close object and call close() on that any time. Throws CloseVetoException if listener disagree with the close request on listened object he must throw this exception
notifyClosing
void
notifyClosing( | [in] ::com::sun::star::lang::EventObject | Source );
Description is called when the listened object is closed really Now the listened object is closed really. Listener has to accept that; should deregister himself and release all references to it. It's not allowed nor possible to disagree with that by throwing any exception. If the event ::com::sun::star::lang::XEventListener::disposing() occurred before it must be accepted too. There exist no chance for a disagreement any more. Parameter Source describes the source of the event (must be the listened object)

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.