slideshow/source/inc/disposable.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_SLIDESHOW_SOURCE_INC_DISPOSABLE_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_INC_DISPOSABLE_HXX
  22
  23 #include <sal/types.h>
  24 #include <memory>
  25
  26
  27 /* Definition of Disposable interface */
  28
  29 namespace slideshow
  30 {
  31     namespace internal
  32     {
  33         /**
  34          * Base class for being a shared pointer, since quite a few of the downstream classes
  35          * want to be stored using std::shared_ptr.
  36          */
  37         class SharedPtrAble : public std::enable_shared_from_this<SharedPtrAble>
  38         {
  39         public:
  40             virtual ~SharedPtrAble() {}
  41         };
  42
  43         /** Disposable interface
  44
  45             With ref-counted objects, deleting object networks
  46             containing cycles requires a dispose() call, to enforce
  47             every object to call dispose on and release local
  48             references.
  49          */
  50         class Disposable
  51         {
  52         public:
  53             virtual ~Disposable() {}
  54
  55             /** Dispose all object references.
  56
  57                 An implementor of this method must first call
  58                 dispose() on any of its external references, and
  59                 release them after that.
  60              */
  61             virtual void dispose() = 0;
  62         };
  63
  64     }
  65 }
  66
  67 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_DISPOSABLE_HXX
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */