You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tqt3/doc/man/man3/tqstrlist.3qt

93 lines
4.0 KiB

'\" t
.TH TQStrList 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
TQStrList \- Doubly-linked list of char*
.SH SYNOPSIS
\fC#include <tqstrlist.h>\fR
.PP
Inherits TQPtrList<char>.
.PP
Inherited by TQStrIList.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBTQStrList\fR ( bool deepCopies = TRUE )"
.br
.ti -1c
.BI "\fBTQStrList\fR ( const TQStrList & list )"
.br
.ti -1c
.BI "\fB~TQStrList\fR ()"
.br
.ti -1c
.BI "TQStrList & \fBoperator=\fR ( const TQStrList & list )"
.br
.in -1c
.SH DESCRIPTION
The TQStrList class provides a doubly-linked list of char*.
.PP
If you want a string list of TQStrings use TQStringList.
.PP
This class is a TQPtrList<char> instance (a list of char*).
.PP
TQStrList 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 TQStrList that operates on deep copies will, by default, turn on auto-deletion (see setAutoDelete()). Thus, by default TQStrList 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 TQStrListIterator class is an iterator for TQStrList.
.PP
See also Collection Classes, Text Related Classes, and Non-GUI Classes.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "TQStrList::TQStrList ( 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 "TQStrList::TQStrList ( const TQStrList & 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 "TQStrList::~TQStrList ()"
Destroys the list. All strings are removed.
.SH "TQStrList & TQStrList::operator= ( const TQStrList & 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/tqstrlist.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 TQt documentation is provided in HTML format; it is
located at $TQTDIR/doc/html and can be read using TQt 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 qt-bugs@trolltech.com .
Please include the name of the manual page (tqstrlist.3qt) and the Qt
version (3.3.8).