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