KStringHandler Class Reference
This class contains utility functions for handling strings. Class for manipulating words and sentences in strings. More...
#include <kstringhandler.h>
Static Public Member Functions | |
QString | word (const QString &text, uint pos) KDE_DEPRECATED |
QString | word (const QString &text, const char *range) |
QString | insword (const QString &text, const QString &word, uint pos) |
QString | setword (const QString &text, const QString &word, uint pos) |
QString | remrange (const QString &text, const char *range) |
QString | remword (const QString &text, uint pos) |
QString | remword (const QString &text, const QString &word) |
QString | capwords (const QString &text) |
QStringList | capwords (const QStringList &list) |
QString | reverse (const QString &text) |
QStringList | reverse (const QStringList &list) |
QString | ljust (const QString &text, uint width) KDE_DEPRECATED |
QString | rjust (const QString &text, uint width) KDE_DEPRECATED |
QString | center (const QString &text, uint width) |
QString | lsqueeze (const QString &str, uint maxlen=40) |
QString | lEmSqueeze (const QString &name, const QFontMetrics &fontMetrics, uint maxlen=30) |
QString | lPixelSqueeze (const QString &name, const QFontMetrics &fontMetrics, uint maxPixels) |
QString | csqueeze (const QString &str, uint maxlen=40) |
QString | cEmSqueeze (const QString &name, const QFontMetrics &fontMetrics, uint maxlen=30) |
QString | cPixelSqueeze (const QString &name, const QFontMetrics &fontMetrics, uint maxPixels) |
QString | rsqueeze (const QString &str, uint maxlen=40) |
QString | rEmSqueeze (const QString &name, const QFontMetrics &fontMetrics, uint maxlen=30) |
QString | rPixelSqueeze (const QString &name, const QFontMetrics &fontMetrics, uint maxPixels) |
bool | matchFileName (const QString &filename, const QString &pattern) |
QStringList | perlSplit (const QString &sep, const QString &s, uint max=0) |
QStringList | perlSplit (const QChar &sep, const QString &s, uint max=0) |
QStringList | perlSplit (const QRegExp &sep, const QString &s, uint max=0) |
QString | tagURLs (const QString &text) |
QString | obscure (const QString &str) |
bool | isUtf8 (const char *str) |
QString | from8Bit (const char *str) |
KDE_DEPRECATED bool | matchFilename (const QString &filename, const QString &pattern) |
Detailed Description
This class contains utility functions for handling strings. Class for manipulating words and sentences in strings.This class is not a substitute for the QString class. What I tried to do with this class is provide an easy way to cut/slice/splice words inside sentences in whatever order desired. While the main focus of this class are words (ie characters separated by spaces/tabs), the two core functions here ( split() and join() ) will function given any char to use as a separator. This will make it easy to redefine what a 'word' means in the future if needed.
I freely stole some of the function names from python. I also think some of these were influenced by mIRC (yes, believe it if you will, I used to write a LOT of scripts in mIRC).
The ranges are a fairly powerful way of getting/stripping words from a string. These ranges function, for the large part, as they would in python. See the word(const QString&, int) and remword(const QString&, int) functions for more detail.
This class contains no data members of it own. All strings are cut on the fly and returned as new qstrings/qstringlists.
Quick example on how to use:
KStringHandler kstr; QString line = "This is a test of the strings"; cout << "1> " << kstr.word( line , "4:" ) << "\n"; cout << "2> " << kstr.remrange( line , "2:5" ) << "\n"; cout << "2> " << kstr.reverse( line ) << "\n"; cout << "2> " << kstr.center( kstr.word( line , 4 ) , 15 ) << "\n";
and so forth.
- Author:
- Ian Zepp <icszepp@islc.net>
- See also:
- KShell
Definition at line 70 of file kstringhandler.h.
Member Function Documentation
|
Returns the nth word in the string if found Returns a EMPTY (not null) string otherwise. Note that the FIRST index is 0.
|
|
Returns a range of words from that string. Ie:
|
|
Inserts a word into the string, and returns a new string with the word included.
the first index is zero (0). If there are not
|
|
Replaces a word in the string, and returns a new string with the word included.
the first index is zero (0). If there are not
|
|
Removes a word or ranges of words from the string, and returns a new string. The ranges definitions follow the definitions for the word() function.
|
|
Removes a word at the given index, and returns a new string. The first index is zero (0).
|
|
Removes a matching word from the string, and returns a new string. Note that only ONE match is removed.
|
|
Capitalizes each word in the string "hello there" becomes "Hello There" (string).
|
|
Capitalizes each word in the list [hello, there] becomes [Hello, There] (list).
|
|
Reverses the order of the words in a string "hello there" becomes "there hello" (string).
|
|
Reverses the order of the words in a list [hello, there] becomes [there, hello] (list).
|
|
Left-justifies a string and returns a string at least 'width' characters wide.
If the string is longer than the
|
|
Right-justifies a string and returns a string at least 'width' characters wide.
If the string is longer than the
|
|
Centers a string and returns a string at least 'width' characters wide.
If the string is longer than the
|
|
Substitute characters at the beginning of a string by "...".
|
|
Substitute characters at the beginning of a string by "...". Similar to method above, except that it truncates based on pixel width rather than the number of characters
References lPixelSqueeze(). |
|
Substitute characters at the beginning of a string by "...". Similar to method above, except that maxlen is the width in pixels to truncate to
Referenced by lEmSqueeze(). |
|
Substitute characters at the middle of a string by "...".
|
|
Substitute characters in the middle of a string by "...". Similar to method above, except that it truncates based on pixel width rather than the number of characters
References cPixelSqueeze(). |
|
Substitute characters in the middle of a string by "...". Similar to method above, except that maxlen is the width in pixels to truncate to
Referenced by cEmSqueeze(). |
|
Substitute characters at the end of a string by "...".
|
|
Substitute characters at the end of a string by "...". Similar to method above, except that it truncates based on pixel width rather than the number of characters
References rPixelSqueeze(). |
|
Substitute characters at the end of a string by "...". Similar to method above, except that maxlen is the width in pixels to truncate to
Referenced by rEmSqueeze(). |
|
Match a filename.
Referenced by matchFilename(). |
|
Split a QString into a QStringList in a similar fashion to the static QStringList function in Qt, except you can specify a maximum number of tokens. If max is specified (!= 0) then only that number of tokens will be extracted. The final token will be the remainder of the string. Example: perlSplit("__", "some__string__for__you__here", 4) QStringList contains: "some", "string", "for", "you__here"
|
|
Split a QString into a QStringList in a similar fashion to the static QStringList function in Qt, except you can specify a maximum number of tokens. If max is specified (!= 0) then only that number of tokens will be extracted. The final token will be the remainder of the string. Example: perlSplit(' ', "kparts reaches the parts other parts can't", 3) QStringList contains: "kparts", "reaches", "the parts other parts can't"
|
|
Split a QString into a QStringList in a similar fashion to the static QStringList function in Qt, except you can specify a maximum number of tokens. If max is specified (!= 0) then only that number of tokens will be extracted. The final token will be the remainder of the string. Example: perlSplit(QRegExp("[! ]", "Split me up ! I'm bored ! OK ?", 3) QStringList contains: "Split", "me", "up ! I'm bored, OK ?"
|
|
This method auto-detects URLs in strings, and adds HTML markup to them so that richtext or HTML-enabled widgets (such as KActiveLabel) will display the URL correctly.
|
|
Obscure string by using a simple symmetric encryption. Applying the function to a string obscured by this function will result in the original string. The function can be used to obscure passwords stored to configuration files. Note that this won't give you any more security than preventing that the password is directly copied and pasted.
|
|
Guess whether a string is UTF8 encoded.
Referenced by from8Bit(). |
|
Construct QString from a c string, guessing whether it is UTF8- or Local8Bit-encoded.
References isUtf8(), and KGlobal::staticQString(). Referenced by KConfigBase::readEntry(), and KConfigBase::writeEntry(). |
|
References matchFileName(). |
The documentation for this class was generated from the following files: