slideshow/source/inc/disposable.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: disposable.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_DISPOSABLE_HXX
  32 #define INCLUDED_SLIDESHOW_DISPOSABLE_HXX
  33
  34 #include <sal/types.h>
  35 #include <boost/shared_ptr.hpp>
  36
  37
  38 /* Definition of Disposable interface */
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44         /** Disposable interface
  45
  46             With ref-counted objects, deleting object networks
  47             containing cycles requires a dispose() call, to enforce
  48             every object to call dispose on and release local
  49             references.
  50          */
  51         class Disposable
  52         {
  53         public:
  54             virtual ~Disposable() {}
  55
  56             /** Dispose all object references.
  57
  58                 An implementor of this method must first call
  59                 dispose() on any of its external references, and
  60                 release them after that.
  61              */
  62             virtual void dispose() = 0;
  63         };
  64
  65     }
  66 }
  67
  68 #endif /* INCLUDED_SLIDESHOW_DISPOSABLE_HXX */