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 #include "unotools/unotoolsdllapi.h"
  20
  21 #ifndef UNOTOOLS_INC_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX
  22 #define UNOTOOLS_INC_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX
  23
  24 //........................................................................
  25 namespace utl
  26 {
  27 //........................................................................
  28
  29     //====================================================================
  30     //= ITerminationListener
  31     //====================================================================
  32     /** non-UNO version of the <type scope="com.sun.star.frame">XTerminateListener</type>
  33     */
  34     class ITerminationListener
  35     {
  36     public:
  37         virtual bool    queryTermination() const = 0;
  38         virtual void    notifyTermination() = 0;
  39
  40     protected:
  41         ~ITerminationListener() {}
  42     };
  43
  44     //====================================================================
  45     //= DesktopTerminationObserver
  46     //====================================================================
  47     /** a class which allows non-UNO components to observe the desktop (aka application)
  48         for it's shutdown
  49     */
  50     class UNOTOOLS_DLLPUBLIC DesktopTerminationObserver
  51     {
  52     public:
  53         /** registers a listener which should be notified when the desktop terminates
  54             (which means the application is shutting down)
  55         */
  56         static void    registerTerminationListener( ITerminationListener* _pListener );
  57
  58         /** revokes a termination listener
  59         */
  60         static void    revokeTerminationListener( ITerminationListener* _pListener );
  61
  62     private:
  63         DesktopTerminationObserver();   // never implemented, only static methods
  64     };
  65
  66 //........................................................................
  67 } // namespace utl
  68 //........................................................................
  69
  70 #endif // UNOTOOLS_INC_UNOTOOLS_DESKTOPTERMINATIONOBSERVER_HXX
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */