include/unotools/desktopterminationobserver.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX
  21 #define INCLUDED_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX
  22
  23 #include <unotools/unotoolsdllapi.h>
  24
  25 namespace utl
  26 {
  27
  28     //= ITerminationListener
  29
  30     /** non-UNO version of the com.sun.star.frame::XTerminateListener
  31     */
  32     class ITerminationListener
  33     {
  34     public:
  35         virtual bool    queryTermination() const = 0;
  36         virtual void    notifyTermination() = 0;
  37
  38     protected:
  39         ~ITerminationListener() {}
  40     };
  41
  42     //= DesktopTerminationObserver
  43
  44     /** a class which allows non-UNO components to observe the desktop (aka application)
  45         for its shutdown
  46     */
  47     namespace DesktopTerminationObserver
  48     {
  49         /** registers a listener which should be notified when the desktop terminates
  50             (which means the application is shutting down)
  51         */
  52         UNOTOOLS_DLLPUBLIC void    registerTerminationListener( ITerminationListener* _pListener );
  53
  54         /** revokes a termination listener
  55         */
  56         UNOTOOLS_DLLPUBLIC void    revokeTerminationListener( ITerminationListener const * _pListener );
  57     }
  58
  59 } // namespace utl
  60
  61 #endif // INCLUDED_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */