summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/qstrlist.3qt
blob: 650d0183212e47526de29bd2772cf6d413af1bbf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
'\" t
.TH QStrList 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QStrList \- Doubly-linked list of char*
.SH SYNOPSIS
\fC#include <qstrlist.h>\fR
.PP
Inherits QPtrList<char>.
.PP
Inherited by QStrIList.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQStrList\fR ( bool deepCopies = TRUE )"
.br
.ti -1c
.BI "\fBQStrList\fR ( const QStrList & list )"
.br
.ti -1c
.BI "\fB~QStrList\fR ()"
.br
.ti -1c
.BI "QStrList & \fBoperator=\fR ( const QStrList & list )"
.br
.in -1c
.SH DESCRIPTION
The QStrList class provides a doubly-linked list of char*.
.PP
If you want a string list of QStrings use QStringList.
.PP
This class is a QPtrList<char> instance (a list of char*).
.PP
QStrList can make deep or shallow copies of the strings that are inserted.
.PP
A deep copy means that memory is allocated for the string and then the string data is copied into that memory. A shallow copy is just a copy of the pointer value and not of the string data itself.
.PP
The disadvantage of shallow copies is that because a pointer can be deleted only once, the program must put all strings in a central place and know when it is safe to delete them (i.e. when the strings are no longer referenced by other parts of the program). This can make the program more complex. The advantage of shallow copies is that they consume far less memory than deep copies. It is also much faster to copy a pointer (typically 4 or 8 bytes) than to copy string data.
.PP
A QStrList that operates on deep copies will, by default, turn on auto-deletion (see setAutoDelete()). Thus, by default QStrList will deallocate any string copies it allocates.
.PP
The virtual compareItems() function is reimplemented and does a case-sensitive string comparison. The inSort() function will insert strings in sorted order. In general it is fastest to insert the strings as they come and sort() at the end; inSort() is useful when you just have to add a few extra strings to an already sorted list.
.PP
The QStrListIterator class is an iterator for QStrList.
.PP
See also Collection Classes, Text Related Classes, and Non-GUI Classes.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QStrList::QStrList ( bool deepCopies = TRUE )"
Constructs an empty list of strings. Will make deep copies of all inserted strings if \fIdeepCopies\fR is TRUE, or use shallow copies if \fIdeepCopies\fR is FALSE.
.SH "QStrList::QStrList ( const QStrList & list )"
Constructs a copy of \fIlist\fR.
.PP
If \fIlist\fR has deep copies, this list will also get deep copies. Only the pointers are copied (shallow copy) if the other list does not use deep copies.
.SH "QStrList::~QStrList ()"
Destroys the list. All strings are removed.
.SH "QStrList & QStrList::operator= ( const QStrList & list )"
Assigns \fIlist\fR to this list and returns a reference to this list.
.PP
If \fIlist\fR has deep copies, this list will also get deep copies.
Only the pointers are copied (shallow copy) if the other list does
not use deep copies.

.SH "SEE ALSO"
.BR http://doc.trolltech.com/qstrlist.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR [email protected] .
Please include the name of the manual page (qstrlist.3qt) and the Qt
version (3.3.8).