<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qstringmatcher.cpp --> <title>Qt 4.8: QStringMatcher Class Reference</title> <link rel="stylesheet" type="text/css" href="style/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <div class="breadcrumb toolblock"> <ul> <li class="first"><a href="index.html">Home</a></li> <!-- Breadcrumbs go here --> <li><a href="modules.html">Modules</a></li> <li><a href="qtcore.html">QtCore</a></li> <li>QStringMatcher</li> </ul> </div> <div class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></li> </ul> </div> </div> <div class="content mainContent"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">QStringMatcher Class Reference</h1> <!-- $$$QStringMatcher-brief --> <p>The QStringMatcher class holds a sequence of characters that can be quickly matched in a Unicode string. <a href="#details">More...</a></p> <!-- @@@QStringMatcher --> <pre class="cpp"> <span class="preprocessor">#include <QStringMatcher></span></pre><ul> <li><a href="qstringmatcher-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-functions"></a> <h2>Public Functions</h2> <table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#QStringMatcher">QStringMatcher</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#QStringMatcher-2">QStringMatcher</a></b> ( const QString & <i>pattern</i>, Qt::CaseSensitivity <i>cs</i> = Qt::CaseSensitive )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#QStringMatcher-3">QStringMatcher</a></b> ( const QChar * <i>uc</i>, int <i>length</i>, Qt::CaseSensitivity <i>cs</i> = Qt::CaseSensitive )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#QStringMatcher-4">QStringMatcher</a></b> ( const QStringMatcher & <i>other</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#dtor.QStringMatcher">~QStringMatcher</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::CaseSensitivity </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#caseSensitivity">caseSensitivity</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#indexIn">indexIn</a></b> ( const QString & <i>str</i>, int <i>from</i> = 0 ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#indexIn-2">indexIn</a></b> ( const QChar * <i>str</i>, int <i>length</i>, int <i>from</i> = 0 ) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#pattern">pattern</a></b> () const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#setCaseSensitivity">setCaseSensitivity</a></b> ( Qt::CaseSensitivity <i>cs</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#setPattern">setPattern</a></b> ( const QString & <i>pattern</i> )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QStringMatcher & </td><td class="memItemRight bottomAlign"><b><a href="qstringmatcher.html#operator-eq">operator=</a></b> ( const QStringMatcher & <i>other</i> )</td></tr> </table> <a name="details"></a> <!-- $$$QStringMatcher-description --> <div class="descr"> <h2>Detailed Description</h2> <p>The QStringMatcher class holds a sequence of characters that can be quickly matched in a Unicode string.</p> <p>This class is useful when you have a sequence of <a href="qchar.html">QChar</a>s that you want to repeatedly match against some strings (perhaps in a loop), or when you want to search for the same sequence of characters multiple times in the same string. Using a matcher object and <a href="qstringmatcher.html#indexIn">indexIn</a>() is faster than matching a plain <a href="qstring.html">QString</a> with <a href="qstring.html#indexOf">QString::indexOf</a>() if repeated matching takes place. This class offers no benefit if you are doing one-off string matches.</p> <p>Create the QStringMatcher with the <a href="qstring.html">QString</a> you want to search for. Then call <a href="qstringmatcher.html#indexIn">indexIn</a>() on the <a href="qstring.html">QString</a> that you want to search.</p> </div> <p><b>See also </b><a href="qstring.html">QString</a>, <a href="qbytearraymatcher.html">QByteArrayMatcher</a>, and <a href="qregexp.html">QRegExp</a>.</p> <!-- @@@QStringMatcher --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QStringMatcher[overload1]$$$QStringMatcher --> <h3 class="fn"><a name="QStringMatcher"></a>QStringMatcher::<span class="name">QStringMatcher</span> ()</h3> <p>Constructs an empty string matcher that won't match anything. Call <a href="qstringmatcher.html#setPattern">setPattern</a>() to give it a pattern to match.</p> <!-- @@@QStringMatcher --> <!-- $$$QStringMatcher$$$QStringMatcherconstQString&Qt::CaseSensitivity --> <h3 class="fn"><a name="QStringMatcher-2"></a>QStringMatcher::<span class="name">QStringMatcher</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>pattern</i>, <span class="type"><a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a></span> <i>cs</i> = Qt::CaseSensitive )</h3> <p>Constructs a string matcher that will search for <i>pattern</i>, with case sensitivity <i>cs</i>.</p> <p>Call <a href="qstringmatcher.html#indexIn">indexIn</a>() to perform a search.</p> <!-- @@@QStringMatcher --> <!-- $$$QStringMatcher$$$QStringMatcherconstQChar*intQt::CaseSensitivity --> <h3 class="fn"><a name="QStringMatcher-3"></a>QStringMatcher::<span class="name">QStringMatcher</span> ( const <span class="type"><a href="qchar.html">QChar</a></span> * <i>uc</i>, <span class="type">int</span> <i>length</i>, <span class="type"><a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a></span> <i>cs</i> = Qt::CaseSensitive )</h3> <p>Constructs a string matcher that will search for the pattern referred to by <i>uc</i> with the given <i>length</i> and case sensitivity specified by <i>cs</i>.</p> <p>This function was introduced in Qt 4.5.</p> <!-- @@@QStringMatcher --> <!-- $$$QStringMatcher$$$QStringMatcherconstQStringMatcher& --> <h3 class="fn"><a name="QStringMatcher-4"></a>QStringMatcher::<span class="name">QStringMatcher</span> ( const <span class="type">QStringMatcher</span> & <i>other</i> )</h3> <p>Copies the <i>other</i> string matcher to this string matcher.</p> <!-- @@@QStringMatcher --> <!-- $$$~QStringMatcher[overload1]$$$~QStringMatcher --> <h3 class="fn"><a name="dtor.QStringMatcher"></a>QStringMatcher::<span class="name">~QStringMatcher</span> ()</h3> <p>Destroys the string matcher.</p> <!-- @@@~QStringMatcher --> <!-- $$$caseSensitivity[overload1]$$$caseSensitivity --> <h3 class="fn"><a name="caseSensitivity"></a><span class="type"><a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a></span> QStringMatcher::<span class="name">caseSensitivity</span> () const</h3> <p>Returns the case sensitivity setting for this string matcher.</p> <p><b>See also </b><a href="qstringmatcher.html#setCaseSensitivity">setCaseSensitivity</a>().</p> <!-- @@@caseSensitivity --> <!-- $$$indexIn[overload1]$$$indexInconstQString&int --> <h3 class="fn"><a name="indexIn"></a><span class="type">int</span> QStringMatcher::<span class="name">indexIn</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>str</i>, <span class="type">int</span> <i>from</i> = 0 ) const</h3> <p>Searches the string <i>str</i> from character position <i>from</i> (default 0, i.e. from the first character), for the string <a href="qstringmatcher.html#pattern">pattern</a>() that was set in the constructor or in the most recent call to <a href="qstringmatcher.html#setPattern">setPattern</a>(). Returns the position where the <a href="qstringmatcher.html#pattern">pattern</a>() matched in <i>str</i>, or -1 if no match was found.</p> <p><b>See also </b><a href="qstringmatcher.html#setPattern">setPattern</a>() and <a href="qstringmatcher.html#setCaseSensitivity">setCaseSensitivity</a>().</p> <!-- @@@indexIn --> <!-- $$$indexIn$$$indexInconstQChar*intint --> <h3 class="fn"><a name="indexIn-2"></a><span class="type">int</span> QStringMatcher::<span class="name">indexIn</span> ( const <span class="type"><a href="qchar.html">QChar</a></span> * <i>str</i>, <span class="type">int</span> <i>length</i>, <span class="type">int</span> <i>from</i> = 0 ) const</h3> <p>Searches the string starting at <i>str</i> (of length <i>length</i>) from character position <i>from</i> (default 0, i.e. from the first character), for the string <a href="qstringmatcher.html#pattern">pattern</a>() that was set in the constructor or in the most recent call to <a href="qstringmatcher.html#setPattern">setPattern</a>(). Returns the position where the <a href="qstringmatcher.html#pattern">pattern</a>() matched in <i>str</i>, or -1 if no match was found.</p> <p>This function was introduced in Qt 4.5.</p> <p><b>See also </b><a href="qstringmatcher.html#setPattern">setPattern</a>() and <a href="qstringmatcher.html#setCaseSensitivity">setCaseSensitivity</a>().</p> <!-- @@@indexIn --> <!-- $$$pattern[overload1]$$$pattern --> <h3 class="fn"><a name="pattern"></a><span class="type"><a href="qstring.html">QString</a></span> QStringMatcher::<span class="name">pattern</span> () const</h3> <p>Returns the string pattern that this string matcher will search for.</p> <p><b>See also </b><a href="qstringmatcher.html#setPattern">setPattern</a>().</p> <!-- @@@pattern --> <!-- $$$setCaseSensitivity[overload1]$$$setCaseSensitivityQt::CaseSensitivity --> <h3 class="fn"><a name="setCaseSensitivity"></a><span class="type">void</span> QStringMatcher::<span class="name">setCaseSensitivity</span> ( <span class="type"><a href="qt.html#CaseSensitivity-enum">Qt::CaseSensitivity</a></span> <i>cs</i> )</h3> <p>Sets the case sensitivity setting of this string matcher to <i>cs</i>.</p> <p><b>See also </b><a href="qstringmatcher.html#caseSensitivity">caseSensitivity</a>(), <a href="qstringmatcher.html#setPattern">setPattern</a>(), and <a href="qstringmatcher.html#indexIn">indexIn</a>().</p> <!-- @@@setCaseSensitivity --> <!-- $$$setPattern[overload1]$$$setPatternconstQString& --> <h3 class="fn"><a name="setPattern"></a><span class="type">void</span> QStringMatcher::<span class="name">setPattern</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>pattern</i> )</h3> <p>Sets the string that this string matcher will search for to <i>pattern</i>.</p> <p><b>See also </b><a href="qstringmatcher.html#pattern">pattern</a>(), <a href="qstringmatcher.html#setCaseSensitivity">setCaseSensitivity</a>(), and <a href="qstringmatcher.html#indexIn">indexIn</a>().</p> <!-- @@@setPattern --> <!-- $$$operator=[overload1]$$$operator=constQStringMatcher& --> <h3 class="fn"><a name="operator-eq"></a><span class="type">QStringMatcher</span> & QStringMatcher::<span class="name">operator=</span> ( const <span class="type">QStringMatcher</span> & <i>other</i> )</h3> <p>Assigns the <i>other</i> string matcher to this string matcher.</p> <!-- @@@operator= --> </div> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.</p> <br /> <p> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.</p> <p> Documentation sources may be obtained from <a href="http://www.qt-project.org"> www.qt-project.org</a>.</p> <br /> <p> Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. <a title="Privacy Policy" href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p> </div> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>