xref: /trunk/main/slideshow/source/inc/disposable.hxx (revision aaef562f)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef INCLUDED_SLIDESHOW_DISPOSABLE_HXX
25 #define INCLUDED_SLIDESHOW_DISPOSABLE_HXX
26 
27 #include <sal/types.h>
28 #include <boost/shared_ptr.hpp>
29 
30 
31 /* Definition of Disposable interface */
32 
33 namespace slideshow
34 {
35     namespace internal
36     {
37         /** Disposable interface
38 
39         	With ref-counted objects, deleting object networks
40         	containing cycles requires a dispose() call, to enforce
41         	every object to call dispose on and release local
42         	references.
43          */
44         class Disposable
45         {
46         public:
~Disposable()47             virtual ~Disposable() {}
48 
49             /** Dispose all object references.
50 
51             	An implementor of this method must first call
52             	dispose() on any of its external references, and
53             	release them after that.
54              */
55             virtual void dispose() = 0;
56         };
57 
58     }
59 }
60 
61 #endif /* INCLUDED_SLIDESHOW_DISPOSABLE_HXX */
62