QStringList Class Reference

A list of strings. More...

#include <qstringlist.h>

Inheritance diagram for QStringList:

Public Member Functions
	QStringList ()
	QStringList (const QStringList &l)
	QStringList (const QValueList< QString > &l)
	QStringList (const QString &i)
	QStringList (const char *i)
void	sort ()
QString	join (const QString &sep) const
QStringList	grep (const QString &str, bool cs=TRUE) const
QStringList	grep (const QRegExp &expr) const
Public Member Functions inherited from QValueList< QString >
	QValueList ()
	QValueList (const QValueList< QString > &l)
	~QValueList ()
QValueList< QString > &	operator= (const QValueList< QString > &l)
QValueList< QString >	operator+ (const QValueList< QString > &l) const
QValueList< QString > &	operator+= (const QValueList< QString > &l)
QValueList< QString > &	operator+= (const QString &x)
bool	operator== (const QValueList< QString > &l) const
bool	operator!= (const QValueList< QString > &l) const
Iterator	begin ()
ConstIterator	begin () const
Iterator	end ()
ConstIterator	end () const
Iterator	fromLast ()
ConstIterator	fromLast () const
bool	isEmpty () const
Iterator	insert (Iterator it, const QString &x)
Iterator	append (const QString &x)
Iterator	prepend (const QString &x)
Iterator	remove (Iterator it)
void	remove (const QString &x)
QString &	first ()
const QString &	first () const
QString &	last ()
const QString &	last () const
QString &	operator[] (uint i)
const QString &	operator[] (uint i) const
Iterator	at (uint i)
ConstIterator	at (uint i) const
Iterator	find (const QString &x)
ConstIterator	find (const QString &x) const
Iterator	find (Iterator it, const QString &x)
ConstIterator	find (ConstIterator it, const QString &x) const
int	findIndex (const QString &x) const
uint	contains (const QString &x) const
uint	count () const
void	clear ()
QValueList< QString > &	operator<< (const QString &x)

Static Public Member Functions
static QStringList	fromStrList (const QStrList &)
static QStringList	split (const QString &sep, const QString &str, bool allowEmptyEntries=FALSE)
static QStringList	split (const QCString &sep, const QCString &str, bool allowEmptyEntries=FALSE)
static QStringList	split (const QChar &sep, const QString &str, bool allowEmptyEntries=FALSE)
static QStringList	split (const QRegExp &sep, const QString &str, bool allowEmptyEntries=FALSE)

Additional Inherited Members
Public Types inherited from QValueList< QString >
typedef QValueListIterator< QString >	Iterator
typedef QValueListConstIterator< QString >	ConstIterator
typedef QString	ValueType
Protected Member Functions inherited from QValueList< QString >
void	detach ()
Protected Attributes inherited from QValueList< QString >
QValueListPrivate< QString > *	sh

Detailed Description

A list of strings.

QStringList is basically a QValueList of QString objects. As opposed to QStrList, that stores pointers to characters, QStringList deals with real QString objects. It is the class of choice whenever you work with unicode strings.

Like QString itself, QStringList objects are implicit shared. Passing them around as value-parameters is both fast and safe.

Example:

QStringList list;

// three different ways of appending values:
list.append( "Torben");
list += "Warwick";
list << "Matthias" << "Arnt" << "Paul";

// sort the list, Arnt's now first
list.sort();

// print it out
for ( QStringList::Iterator it = list.begin(); it != list.end(); ++it ) {
    printf( "%s \n", (*it).latin1() );
}

Convenience methods such as sort(), split(), join() and grep() make working with QStringList easy.

Definition at line 51 of file qstringlist.h.

Constructor & Destructor Documentation

QStringList::QStringList ( )

inline

Creates an empty list.

Definition at line 54 of file qstringlist.h.

{ }

QStringList::QStringList ( const QStringList &  l )

inline

Creates a copy of the list. This function is very fast since QStringList is implicit shared. However, for the programmer this is the same as a deep copy. If this list or the original one or some other list referencing the same shared data is modified, then the modifying list makes a copy first.

Definition at line 55 of file qstringlist.h.

: QValueList<QString>(l) { }

QStringList::QStringList ( const QValueList< QString > &  l )

inline

Constructs a new string list that is a copy of l.

Definition at line 56 of file qstringlist.h.

: QValueList<QString>(l) { }

QStringList::QStringList ( const QString &  i )

inline

Constructs a string list consisting of the single string i. To make longer lists easily, use:

QString s1,s2,s3;
...
QStringList mylist = QStringList() << s1 << s2 << s3;

Definition at line 57 of file qstringlist.h.

{ append(i); }

QStringList::QStringList ( const char *  i )

inline

Constructs a string list consisting of the single latin-1 string i.

Definition at line 59 of file qstringlist.h.

{ append(i); }

Member Function Documentation

QStringList QStringList::fromStrList ( const QStrList &  ascii )

static

Converts from a QStrList (ASCII) to a QStringList (Unicode).

Definition at line 298 of file qstringlist.cpp.

{
    QStringList res;
    const char * s;
    for ( QStrListIterator it(ascii); (s=it.current()); ++it )
        res << s;
    return res;
}

QStringList QStringList::grep	(	const QString &	str,
		bool	cs = TRUE
	)		const

Returns a list of all strings containing the substring str.

If cs is TRUE, the grep is done case sensitively, else not.

Definition at line 238 of file qstringlist.cpp.

{
    QStringList res;
    for ( QStringList::ConstIterator it = begin(); it != end(); ++it )
        if ( (*it).contains( str, cs ) )
            res << *it;

    return res;
}

QStringList QStringList::grep

(

const QRegExp &

expr

)

const

Returns a list of all strings containing a substring that matches the regular expression expr.

Definition at line 253 of file qstringlist.cpp.

{
    QStringList res;
    for ( QStringList::ConstIterator it = begin(); it != end(); ++it )
        if ( (*it).contains( expr ) )
            res << *it;

    return res;
}

QString QStringList::join

(

const QString &

sep

)

const

Joins the stringlist into a single string with each element separated by sep.

See also

split()

Definition at line 269 of file qstringlist.cpp.

{
    QString res;
    bool alredy = FALSE;
    for ( QStringList::ConstIterator it = begin(); it != end(); ++it ) {
        if ( alredy )
            res += sep;
        alredy = TRUE;
        res += *it;
    }

    return res;
}

void QStringList::sort

(

)

Sorts the list of strings in ascending order.

Sorting is very fast. It uses the Qt Template Library's efficient HeapSort implementation that operates in O(n*log n).

Definition at line 124 of file qstringlist.cpp.

{
    qHeapSort(*this);
}

QStringList QStringList::split ( const QString &  sep, const QString &  str, bool  allowEmptyEntries = FALSE  )

static

Splits the string str using sep as separator. Returns the list of strings. If allowEmptyEntries is TRUE, also empty entries are inserted into the list, else not. So if you have a string 'abc..d.e.', a list which contains 'abc', 'd', and 'e' would be returned if allowEmptyEntries is FALSE, but a list containing 'abc', '', 'd', 'e' and '' would be returned if allowEmptyEntries is TRUE. If str doesn't contain sep, a stringlist with one item, which is the same as str, is returned.

See also

join()

Definition at line 162 of file qstringlist.cpp.

{
    QStringList lst;

    int j = 0;
    int i = str.find( sep, j );

    while ( i != -1 ) {
        if ( str.mid( j, i - j ).length() > 0 )
            lst << str.mid( j, i - j );
        else if ( allowEmptyEntries )
            lst << QString::null;
        j = i + sep.length();
        i = str.find( sep, j );
    }

    int l = str.length() - 1;
    if ( str.mid( j, l - j + 1 ).length() > 0 )
        lst << str.mid( j, l - j + 1 );
    else if ( allowEmptyEntries )
        lst << QString::null;

    return lst;
}

QStringList QStringList::split ( const QCString &  sep, const QCString &  str, bool  allowEmptyEntries = FALSE  )

static

Definition at line 187 of file qstringlist.cpp.

{
  return split(QString(sep.data()),QString(str.data()),allowEmptyEntries);
}

QStringList QStringList::split ( const QChar &  sep, const QString &  str, bool  allowEmptyEntries = FALSE  )

static

Splits the string str using sep as separator. Returns the list of strings. If allowEmptyEntries is TRUE, also empty entries are inserted into the list, else not. So if you have a string 'abc..d.e.', a list which contains 'abc', 'd', and 'e' would be returned if allowEmptyEntries is FALSE, but a list containing 'abc', '', 'd', 'e' and '' would be returned if allowEmptyEntries is TRUE. If str doesn't contain sep, a stringlist with one item, which is the same as str, is returned.

See also

join()

Definition at line 143 of file qstringlist.cpp.

{
    return split( QString( sep ), str, allowEmptyEntries );
}

QStringList QStringList::split ( const QRegExp &  sep, const QString &  str, bool  allowEmptyEntries = FALSE  )

static

Splits the string str using the regular expression sep as separator. Returns the list of strings. If allowEmptyEntries is TRUE, also empty entries are inserted into the list, else not. So if you have a string 'abc..d.e.', a list which contains 'abc', 'd', and 'e' would be returned if allowEmptyEntries is FALSE, but a list containing 'abc', '', 'd', 'e' and '' would be returned if allowEmptyEntries is TRUE. If str doesn't contain sep, a stringlist with one item, which is the same as str, is returned.

See also

join()

Definition at line 206 of file qstringlist.cpp.

{
    QStringList lst;

    int j = 0;
    int len = 0;
    int i = sep.match( str.data(), j, &len );

    while ( i != -1 ) {
        if ( str.mid( j, i - j ).length() > 0 )
            lst << str.mid( j, i - j );
        else if ( allowEmptyEntries )
            lst << QString::null;
        j = i + len;
        i = sep.match( str.data(), j, &len );
    }

    int l = str.length() - 1;
    if ( str.mid( j, l - j + 1 ).length() > 0 )
        lst << str.mid( j, l - j + 1 );
    else if ( allowEmptyEntries )
        lst << QString::null;

    return lst;
}

---

The documentation for this class was generated from the following files:

• doxygen-1.8.11/qtools/qstringlist.h
• doxygen-1.8.11/qtools/qstringlist.cpp