source: trunk/src/qt3support/tools/q3ptrcollection.cpp@ 138

Last change on this file since 138 was 2, checked in by Dmitry A. Kuminov, 16 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.
File size: 5.9 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the Qt3Support module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include "q3ptrcollection.h"
43
44QT_BEGIN_NAMESPACE
45
46/*!
47 \class Q3PtrCollection
48 \reentrant
49 \brief The Q3PtrCollection class is the base class of most pointer-based Qt collections.
50
51 \compat
52
53 The Q3PtrCollection class is an abstract base class for the Qt
54 collection classes QDict, Q3PtrList,
55 etc.
56
57 A Q3PtrCollection only knows about the number of objects in the
58 collection and the deletion strategy (see setAutoDelete()).
59
60 A collection is implemented using the \c Item (generic collection
61 item) type, which is a \c void*. The template classes that create
62 the real collections cast the \c Item to the required type.
63*/
64
65
66/*!
67 \typedef Q3PtrCollection::Item
68
69 This type is the generic "item" in a Q3PtrCollection.
70*/
71
72
73/*!
74 \fn Q3PtrCollection::Q3PtrCollection()
75
76 Constructs a collection. The constructor is protected because
77 Q3PtrCollection is an abstract class.
78*/
79
80/*!
81 \fn Q3PtrCollection::Q3PtrCollection( const Q3PtrCollection & source )
82
83 Constructs a copy of \a source with autoDelete() set to false. The
84 constructor is protected because Q3PtrCollection is an abstract
85 class.
86
87 Note that if \a source has autoDelete turned on, copying it will
88 risk memory leaks, reading freed memory, or both.
89*/
90
91/*!
92 \fn Q3PtrCollection::~Q3PtrCollection()
93
94 Destroys the collection. The destructor is protected because
95 Q3PtrCollection is an abstract class.
96*/
97
98
99/*!
100 \fn bool Q3PtrCollection::autoDelete() const
101
102 Returns the setting of the auto-delete option. The default is false.
103
104 \sa setAutoDelete()
105*/
106
107/*!
108 \fn void Q3PtrCollection::setAutoDelete( bool enable )
109
110 Sets the collection to auto-delete its contents if \a enable is
111 true and to never delete them if \a enable is false.
112
113 If auto-deleting is turned on, all the items in a collection are
114 deleted when the collection itself is deleted. This is convenient
115 if the collection has the only pointer to the items.
116
117 The default setting is false, for safety. If you turn it on, be
118 careful about copying the collection - you might find yourself
119 with two collections deleting the same items.
120
121 Note that the auto-delete setting may also affect other functions
122 in subclasses. For example, a subclass that has a remove()
123 function will remove the item from its data structure, and if
124 auto-delete is enabled, will also delete the item.
125
126 \sa autoDelete()
127*/
128
129