~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QStringList Class Reference</h1>

<p>The QStringList class provides a list of strings. <a href="#details">More...</a></p>

<pre>#include <QStringList></pre><p>Part of the <a href="qtcore.html">QtCore</a> module.</p>

<p>Inherits <a href="qlist.html">QList<QString></a>.</p>

<p><b>Note:</b> All the functions in this class are <a href="threads.html#reentrant">reentrant</a>.</p>

<ul>

<li><a href="qstringlist-members.html">List of all members, including inherited members</a></li>

<li><a href="qstringlist-qt3.html">Qt 3 support members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qstringlist.html#QStringList">QStringList</a></b> ()</li>

<li><div class="fn"/><b><a href="qstringlist.html#QStringList-2">QStringList</a></b> ( const QString & <i>str</i> )</li>

<li><div class="fn"/><b><a href="qstringlist.html#QStringList-3">QStringList</a></b> ( const QStringList & <i>other</i> )</li>

<li><div class="fn"/><b><a href="qstringlist.html#QStringList-4">QStringList</a></b> ( const QList<QString> & <i>other</i> )</li>

<li><div class="fn"/>bool <b><a href="qstringlist.html#contains">contains</a></b> ( const QString & <i>str</i>, Qt::CaseSensitivity <i>cs</i> = Qt::CaseSensitive ) const</li>

<li><div class="fn"/>QStringList <b><a href="qstringlist.html#filter">filter</a></b> ( const QString & <i>str</i>, Qt::CaseSensitivity <i>cs</i> = Qt::CaseSensitive ) const</li>

<li><div class="fn"/>QStringList <b><a href="qstringlist.html#filter-2">filter</a></b> ( const QRegExp & <i>rx</i> ) const</li>

<li><div class="fn"/>int <b><a href="qstringlist.html#indexOf">indexOf</a></b> ( const QRegExp & <i>rx</i>, int <i>from</i> = 0 ) const</li>

<li><div class="fn"/>QString <b><a href="qstringlist.html#join">join</a></b> ( const QString & <i>sep</i> ) const</li>

<li><div class="fn"/>int <b><a href="qstringlist.html#lastIndexOf">lastIndexOf</a></b> ( const QRegExp & <i>rx</i>, int <i>from</i> = -1 ) const</li>

<li><div class="fn"/>QStringList & <b><a href="qstringlist.html#replaceInStrings">replaceInStrings</a></b> ( const QString & <i>before</i>, const QString & <i>after</i>, Qt::CaseSensitivity <i>cs</i> = Qt::CaseSensitive )</li>

<li><div class="fn"/>QStringList & <b><a href="qstringlist.html#replaceInStrings-2">replaceInStrings</a></b> ( const QRegExp & <i>rx</i>, const QString & <i>after</i> )</li>

<li><div class="fn"/>QStringList <b><a href="qstringlist.html#operator-2b">operator+</a></b> ( const QStringList & <i>other</i> ) const</li>

<li><div class="fn"/>QStringList & <b><a href="qstringlist.html#operator-lt-lt">operator<<</a></b> ( const QString & <i>str</i> )</li>

<li><div class="fn"/>QStringList & <b><a href="qstringlist.html#operator-lt-lt-2">operator<<</a></b> ( const QStringList & <i>other</i> )</li>

</ul>

<ul>

<li><div class="fn"/>60 public functions inherited from <a href="qlist.html#public-functions">QList</a></li>

</ul>

<h3>Related Non-Members</h3>

<ul>

<li><div class="fn"/>typedef <b><a href="qstringlist.html#QMutableStringListIterator-typedef">QMutableStringListIterator</a></b></li>

<li><div class="fn"/>typedef <b><a href="qstringlist.html#QStringListIterator-typedef">QStringListIterator</a></b></li>

<li><div class="fn"/>QDataStream & <b><a href="qstringlist.html#operator-lt-lt-53">operator<<</a></b> ( QDataStream & <i>out</i>, const QStringList & <i>list</i> )</li>

<li><div class="fn"/>QDataStream & <b><a href="qstringlist.html#operator-gt-gt-34">operator>></a></b> ( QDataStream & <i>in</i>, QStringList & <i>list</i> )</li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<li><div class="fn"/>3 static public members inherited from <a href="qlist.html#static-public-members">QList</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QStringList class provides a list of strings.</p>

<p>QStringList inherits from <a href="qlist.html">QList</a><<a href="qstring.html">QString</a>>. All of <a href="qlist.html">QList</a>'s functionality also applies to QStringList. For example, you can use <a href="qlist.html#isEmpty">isEmpty</a>() to test whether the list is empty, and you can call functions like <a href="qlist.html#append">append</a>(), <a href="qlist.html#prepend">prepend</a>(), <a href="qlist.html#insert">insert</a>(), <a href="qlist.html#replace">replace</a>(), and <a href="qlist-qt3.html#remove">remove</a>() to modify a QStringList. In addition, QStringList provides a few convenience functions that make handling lists of strings easier.</p>

<p>Like <a href="qlist.html">QList</a>, QStringList is <a href="shclass.html#implicitly-shared">implicitly shared</a>. QStringList provides fast index-based access as well as fast insertions and removals. Passing string lists as value parameters is both fast and safe.</p>

<p>Strings can be added to a list using <a href="qlist.html#append">append</a>(), operator+=(), or operator<<(). For example:</p>

<pre>  QStringList fonts;

fonts << "Arial" << "Helvetica" << "Times" << "Courier";</pre>

<p>To iterate over a string, you can either use index positions or <a href="qlist.html">QList</a>'s Java-style and STL-style iterator types. Here are examples of each approach.</p>

<p>Indexing:</p>

<pre>  for (int i = 0; i < fonts.size(); ++i)

cout << fonts.at(i).ascii() << endl;</pre>

<p>Java-style iterator:</p>

<pre>  QStringListIterator i(fonts);

while (i.hasNext())

cout << i.next().ascii() << endl;</pre>

<p>STL-style iterator:</p>

<pre>  QStringList::const_iterator i;

for (i = fonts.constBegin(); i != fonts.constEnd(); ++i)

cout << (*i).ascii() << endl;</pre>

<p><a href="qstringlist.html#QStringListIterator-typedef">QStringListIterator</a> and <a href="qstringlist.html#QMutableStringListIterator-typedef">QMutableStringListIterator</a> are simply typedefs for <a href="qlistiterator.html">QListIterator</a><<a href="qstring.html">QString</a>> and <a href="qmutablelistiterator.html">QMutableListIterator</a><<a href="qstring.html">QString</a>>.</p>

<p>You can concatenate all the strings in a string list into a single string (with an optional separator) using <a href="qstringlist.html#join">join</a>(). For example:</p>

<pre>  QString str = fonts.join(",");

// str == "Arial,Helvetica,Times,Courier"</pre>

<p>To break up a string into a string list, use <a href="qstring.html#split">QString::split</a>():</p>

<pre>  QString str = "Arial,Helvetica,Times,Courier";

QStringList list = str.split(",");

// list: ["Arial", "Helvetica", "Times", "Courier"]</pre>

<p>The argument to split can be a single character, a string, or a <a href="qregexp.html">QRegExp</a>.</p>

<p>You can sort a string list with <a href="qstringlist.html#sort">sort</a>(), and extract a new list which contains only those strings which contain a particular substring (or match a particular regular expression) using the <a href="qlist-qt3.html#find">find</a>() functions. For example:</p>

<pre>  QStringList monospacedFonts = fonts.find(QRegExp("Courier|Fixed"));</pre>

<p>Similarly, the <a href="qlist.html#replace">replace</a>() function calls <a href="qstring.html#replace">QString::replace</a>() on each string in the string list in turn. Here's an example that uses it to replace all occurrences of "$QTDIR" with "/usr/lib/qt" in a string list:</p>

<pre>  QStringList files;

files << "$QTDIR/src/moc/moc.y"

<< "$QTDIR/src/moc/moc.l"

100

<< "$QTDIR/include/qconfig.h";

101

102

files.replace("$QTDIR", "/usr/lib/qt");</pre>

103

<p>See also <a href="qstring.html">QString</a>, <a href="qstringlist.html#QStringListIterator-typedef">QStringListIterator</a>, and <a href="qstringlist.html#QMutableStringListIterator-typedef">QMutableStringListIterator</a>.</p>

104

<hr />

105

<h2>Member Function Documentation</h2>

106

<h3 class="fn"><a name="QStringList"></a>QStringList::QStringList ()</h3>

107

<p>Constructs an empty string list.</p>

108

<h3 class="fn"><a name="QStringList-2"></a>QStringList::QStringList ( const <a href="qstring.html">QString</a> & <i>str</i> )</h3>

109

<p>Constructs a string list that contains one string, <i>str</i>. Longer lists are easily created like this:</p>

110

<pre>  list = (QStringList() << str1 << str2 << str3);</pre>

111

<h3 class="fn"><a name="QStringList-3"></a>QStringList::QStringList ( const QStringList & <i>other</i> )</h3>

112

<p>Constructs a copy of <i>other</i>.</p>

113

<p>This operation takes <a href="containers.html#constant-time">constant time</a>, because <a href="qstringlist.html">QStringList</a> is <a href="shclass.html#implicitly-shared">implicitly shared</a>. This makes returning a <a href="qstringlist.html">QStringList</a> from a function very fast. If a shared instance is modified, it will be copied (copy-on-write), and that takes <a href="containers.html#linear-time">linear time</a>.</p>

114

<p>See also <a href="qlist.html#operator-eq">operator=</a>().</p>

115

<h3 class="fn"><a name="QStringList-4"></a>QStringList::QStringList ( const <a href="qlist.html">QList</a><<a href="qstring.html">QString</a>> & <i>other</i> )</h3>

116

<p>Constructs a copy of <i>other</i>.</p>

117

118

<p>See also <a href="qlist.html#operator-eq">operator=</a>().</p>

119

<h3 class="fn"><a name="contains"></a>bool QStringList::contains ( const <a href="qstring.html">QString</a> & <i>str</i>, <a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a> <i>cs</i> = Qt::CaseSensitive ) const</h3>

120

<p>Returns true if the list contains the string <i>str</i>. Does a case insensitive search if <i>cs</i> is <a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitive</a>, otherwise the search will be case insensitive.</p>

121

<h3 class="fn"><a name="filter"></a>QStringList QStringList::filter ( const <a href="qstring.html">QString</a> & <i>str</i>, <a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a> <i>cs</i> = Qt::CaseSensitive ) const</h3>

122

<p>Returns a list of all the strings containing the substring <i>str</i>.</p>

123

<p>If <i>cs</i> is <a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitive</a> (the default), the string comparison is case sensitive; otherwise the comparison is case insensitive.</p>

124

<pre>  QStringList list;

125

list << "Bill Murray" << "John Doe" << "Bill Clinton";

126

list = list.filter("Bill");

127

// list: ["Bill Murray", "Bill Clinton"]</pre>

128

<p>See also <a href="qstring.html#contains">QString::contains</a>().</p>

129

<h3 class="fn"><a name="filter-2"></a>QStringList QStringList::filter ( const <a href="qregexp.html">QRegExp</a> & <i>rx</i> ) const</h3>

130

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

131

<p>Returns a list of all the strings that match the regular expression <i>rx</i>.</p>

132

<h3 class="fn"><a name="indexOf"></a>int QStringList::indexOf ( const <a href="qregexp.html">QRegExp</a> & <i>rx</i>, int <i>from</i> = 0 ) const</h3>

133

<p>Returns the index position of the first exact match of <i>rx</i> in the list, searching forward from index position <i>from</i>. Returns -1 if no item matched.</p>

134

<p>See also <a href="qstringlist.html#lastIndexOf">lastIndexOf</a>() and <a href="qregexp.html#exactMatch">QRegExp::exactMatch</a>().</p>

135

<h3 class="fn"><a name="join"></a><a href="qstring.html">QString</a> QStringList::join ( const <a href="qstring.html">QString</a> & <i>sep</i> ) const</h3>

136

<p>Joins the all the string list's strings into a single string with each element separated by the string <i>sep</i> (which can be an empty string).</p>

137

<p>See also <a href="qstring.html#split">QString::split</a>().</p>

138

<h3 class="fn"><a name="lastIndexOf"></a>int QStringList::lastIndexOf ( const <a href="qregexp.html">QRegExp</a> & <i>rx</i>, int <i>from</i> = -1 ) const</h3>

139

<p>Returns the index position of the last exact match of <i>rx</i> in the list, searching backward from index position <i>from</i>. If <i>from</i> is -1 (the default), the search starts at the last item. Returns -1 if no item matched.</p>

140

<p>See also <a href="qstringlist.html#indexOf">indexOf</a>() and <a href="qregexp.html#exactMatch">QRegExp::exactMatch</a>().</p>

141

<h3 class="fn"><a name="replaceInStrings"></a>QStringList & QStringList::replaceInStrings ( const <a href="qstring.html">QString</a> & <i>before</i>, const <a href="qstring.html">QString</a> & <i>after</i>, <a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a> <i>cs</i> = Qt::CaseSensitive )</h3>

142

<p>Returns a string list where every string has had the <i>before</i> text replaced with the <i>after</i> text wherever the <i>before</i> text is found. The <i>before</i> text is matched case-sensitively or not depending on the <i>cs</i> flag.</p>

143

<p>Example:</p>

144

<pre>  QStringList list;

145

list << "alpha" << "beta" << "gamma" << "epsilon";

146

list.replace("a", "o");

147

// list == ["olpho", "beto", "gommo", "epsilon"]</pre>

148

<p>See also <a href="qstring.html#replace">QString::replace</a>().</p>

149

<h3 class="fn"><a name="replaceInStrings-2"></a>QStringList & QStringList::replaceInStrings ( const <a href="qregexp.html">QRegExp</a> & <i>rx</i>, const <a href="qstring.html">QString</a> & <i>after</i> )</h3>

150

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

151

<p>Replaces every occurrence of the regexp <i>rx</i>, in each of the string lists's strings, with <i>after</i>. Returns a reference to the string list.</p>

152

<p>Example:</p>

153

<pre>  QStringList list;

154

list << "alpha" << "beta" << "gamma" << "epsilon";

155

list.replace(QRegExp("^a"), "o");

156

// list == ["olpha", "beta", "gamma", "epsilon"]</pre>

157

<p>For regular expressions that contain <a href="qregexp.html#capturing-parentheses">capturing parentheses</a>, occurrences of <b>\1</b>, <b>\2</b>, ..., in <i>after</i> are replaced with <i>rx</i>.cap(1), <i>rx</i>.cap(2), ...</p>

158

<p>Example:</p>

159

<pre>  QStringList list;

160

list << "Bill Clinton" << "Murray, Bill";

161

list.replace(QRegExp("^(.*), (.*)$"), "\\2 \\1");

162

// list == ["Bill Clinton", "Bill Murray"]</pre>

163

<p>See also <a href="qlist.html#replace">replace</a>().</p>

164

<h3 class="fn"><a name="sort"></a>void QStringList::sort ()</h3>

165

<p>Sorts the list of strings in ascending order (case sensitively).</p>

166

<p>Sorting is performed using Qt's <a href="qtalgorithms.html#qSort">qSort</a>() algorithm, which operates in <a href="containers.html#linear-logarithmic-time">linear-logarithmic time</a>, i.e. O(<i>n</i> log <i>n</i>).</p>

167

<p>If you want to sort your strings in an arbitrary order, consider using a <a href="qmap.html">QMap</a>. For example, you could use a <a href="qmap.html">QMap</a><<a href="qstring.html">QString</a>, <a href="qstring.html">QString</a>> to create a case-insensitive ordering (e.g. with the keys being lower-case versions of the strings, and the values being the strings), or a <a href="qmap.html">QMap</a><int, <a href="qstring.html">QString</a>> to sort the strings by some integer index.</p>

168

<p>See also <a href="qtalgorithms.html#qSort">qSort</a>().</p>

169

<h3 class="fn"><a name="operator-2b"></a>QStringList QStringList::operator+ ( const QStringList & <i>other</i> ) const</h3>

170

<p>Returns a string list that is the concatenation of this string list with the <i>other</i> string list.</p>

171

<p>See also <a href="qlist.html#append">append</a>().</p>

172

<h3 class="fn"><a name="operator-lt-lt"></a>QStringList & QStringList::operator<< ( const <a href="qstring.html">QString</a> & <i>str</i> )</h3>

173

<p>Appends string <i>str</i> to the string list and returns a reference to the string list.</p>

174

<p>See also <a href="qlist.html#append">append</a>().</p>

175

<h3 class="fn"><a name="operator-lt-lt-2"></a>QStringList & QStringList::operator<< ( const QStringList & <i>other</i> )</h3>

176

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

177

<p>Appends <i>other</i> to the string list and returns a reference to the string list.</p>

178

<hr />

179

<h2>Related Non-Members</h2>

180

<h3 class="fn"><a name="QMutableStringListIterator-typedef"></a>typedef QMutableStringListIterator</h3>

181

<p>The <a href="qstringlist.html#QStringListIterator-typedef">QStringListIterator</a> typedef provides a Java-style non-const iterator for <a href="qstringlist.html">QStringList</a>.</p>

182

<p><a href="qstringlist.html">QStringList</a> provides both <a href="containers.html#java-style-iterators">Java-style iterators</a> and <a href="containers.html#stl-style-iterators">STL-style iterators</a>. The Java-style non-const iterator is simply a typedef for <a href="qmutablelistiterator.html">QMutableListIterator</a><<a href="qstring.html">QString</a>>.</p>

183

<p>See also <a href="qstringlist.html#QStringListIterator-typedef">QStringListIterator</a> and <a href="qlist-iterator.html">QStringList::iterator</a>.</p>

184

<h3 class="fn"><a name="QStringListIterator-typedef"></a>typedef QStringListIterator</h3>

185

<p>The QStringListIterator typedef provides a Java-style const iterator for <a href="qstringlist.html">QStringList</a>.</p>

186

<p><a href="qstringlist.html">QStringList</a> provides both <a href="containers.html#java-style-iterators">Java-style iterators</a> and <a href="containers.html#stl-style-iterators">STL-style iterators</a>. The Java-style const iterator is simply a typedef for <a href="qlistiterator.html">QListIterator</a><<a href="qstring.html">QString</a>>.</p>

187

<p>See also <a href="qstringlist.html#QMutableStringListIterator-typedef">QMutableStringListIterator</a> and <a href="qlist-const-iterator.html">QStringList::const_iterator</a>.</p>

188

<h3 class="fn"><a name="operator-lt-lt-53"></a><a href="qdatastream.html">QDataStream</a> & operator<< ( <a href="qdatastream.html">QDataStream</a> & <i>out</i>, const QStringList & <i>list</i> )</h3>

189

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

190

<p>Writes the string list <i>list</i> to stream <i>out</i>.</p>

191

<p>See also <a href="datastreamformat.html">Format of the QDataStream operators</a>.</p>

192

<h3 class="fn"><a name="operator-gt-gt-34"></a><a href="qdatastream.html">QDataStream</a> & operator>> ( <a href="qdatastream.html">QDataStream</a> & <i>in</i>, QStringList & <i>list</i> )</h3>

193

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

194

<p>Reads a string list from stream <i>in</i> into <i>list</i>.</p>

195

<p>See also <a href="datastreamformat.html">Format of the QDataStream operators</a>.</p>

196

197

198

199

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

200

201

</tr></table></div></address></body>

202

</html>

Older »