diff options
Diffstat (limited to 'doc/man/man3/tqcstring.3qt')
| -rw-r--r-- | doc/man/man3/tqcstring.3qt | 110 |
1 files changed, 55 insertions, 55 deletions
diff --git a/doc/man/man3/tqcstring.3qt b/doc/man/man3/tqcstring.3qt index 4013c5165..0178b9fa3 100644 --- a/doc/man/man3/tqcstring.3qt +++ b/doc/man/man3/tqcstring.3qt @@ -63,28 +63,28 @@ Inherits TQByteArray. .BI "TQCString & \fBsprintf\fR ( const char * format, ... )" .br .ti -1c -.BI "int \fBfind\fR ( char c, int index = 0, bool cs = TRUE ) const" +.BI "int \fBfind\fR ( char c, int index = 0, bool cs = true ) const" .br .ti -1c -.BI "int \fBfind\fR ( const char * str, int index = 0, bool cs = TRUE ) const" +.BI "int \fBfind\fR ( const char * str, int index = 0, bool cs = true ) const" .br .ti -1c .BI "int \fBfind\fR ( const TQRegExp & rx, int index = 0 ) const" .br .ti -1c -.BI "int \fBfindRev\fR ( char c, int index = -1, bool cs = TRUE ) const" +.BI "int \fBfindRev\fR ( char c, int index = -1, bool cs = true ) const" .br .ti -1c -.BI "int \fBfindRev\fR ( const char * str, int index = -1, bool cs = TRUE ) const" +.BI "int \fBfindRev\fR ( const char * str, int index = -1, bool cs = true ) const" .br .ti -1c .BI "int \fBfindRev\fR ( const TQRegExp & rx, int index = -1 ) const" .br .ti -1c -.BI "int \fBcontains\fR ( char c, bool cs = TRUE ) const" +.BI "int \fBcontains\fR ( char c, bool cs = true ) const" .br .ti -1c -.BI "int \fBcontains\fR ( const char * str, bool cs = TRUE ) const" +.BI "int \fBcontains\fR ( const char * str, bool cs = true ) const" .br .ti -1c .BI "int \fBcontains\fR ( const TQRegExp & rx ) const" @@ -99,10 +99,10 @@ Inherits TQByteArray. .BI "TQCString \fBmid\fR ( uint index, uint len = 0xffffffff ) const" .br .ti -1c -.BI "TQCString \fBleftJustify\fR ( uint width, char fill = ' ', bool truncate = FALSE ) const" +.BI "TQCString \fBleftJustify\fR ( uint width, char fill = ' ', bool truncate = false ) const" .br .ti -1c -.BI "TQCString \fBrightJustify\fR ( uint width, char fill = ' ', bool truncate = FALSE ) const" +.BI "TQCString \fBrightJustify\fR ( uint width, char fill = ' ', bool truncate = false ) const" .br .ti -1c .BI "TQCString \fBlower\fR () const" @@ -370,18 +370,18 @@ If \fIstr\fR contains a 0 byte within the first \fImaxsize\fR bytes, the resulti See also isNull(). .SH "TQCString & TQCString::append ( const char * str )" Appends string \fIstr\fR to the string and returns a reference to the string. Equivalent to operator+=(). -.SH "int TQCString::contains ( char c, bool cs = TRUE ) const" +.SH "int TQCString::contains ( char c, bool cs = true ) const" Returns the number of times the character \fIc\fR occurs in the string. .PP -The match is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR if FALSE. +The match is case sensitive if \fIcs\fR is true, or case insensitive if \fIcs\fR if false. .PP See also Note on character comparisons. -.SH "int TQCString::contains ( const char * str, bool cs = TRUE ) const" +.SH "int TQCString::contains ( const char * str, bool cs = true ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Returns the number of times \fIstr\fR occurs in the string. .PP -The match is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR if FALSE. +The match is case sensitive if \fIcs\fR is true, or case insensitive if \fIcs\fR if false. .PP This function counts overlapping substrings, for example, "banana" contains two occurrences of "ana". .PP @@ -397,7 +397,7 @@ Example: .br TQString s = "banana and panama"; .br - TQRegExp r = TQRegExp( "a[nm]a", TRUE, FALSE ); + TQRegExp r = TQRegExp( "a[nm]a", true, false ); .br s.contains( r ); // 4 matches .br @@ -415,23 +415,23 @@ Fills the string with \fIlen\fR bytes of character \fIc\fR, followed by a '\ .PP If \fIlen\fR is negative, then the current string length is used. .PP -Returns FALSE is \fIlen\fR is nonnegative and there is not enough memory to resize the string; otherwise returns TRUE. -.SH "int TQCString::find ( char c, int index = 0, bool cs = TRUE ) const" +Returns false is \fIlen\fR is nonnegative and there is not enough memory to resize the string; otherwise returns true. +.SH "int TQCString::find ( char c, int index = 0, bool cs = true ) const" Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR. .PP -The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. +The search is case sensitive if \fIcs\fR is true, or case insensitive if \fIcs\fR is false. .PP Returns the position of \fIc\fR, or -1 if \fIc\fR could not be found. .PP See also Note on character comparisons. .PP Example: network/networkprotocol/nntp.cpp. -.SH "int TQCString::find ( const char * str, int index = 0, bool cs = TRUE ) const" +.SH "int TQCString::find ( const char * str, int index = 0, bool cs = true ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR. .PP -The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. +The search is case sensitive if \fIcs\fR is true, or case insensitive if \fIcs\fR is false. .PP Returns the position of \fIstr\fR, or -1 if \fIstr\fR could not be found. .PP @@ -444,20 +444,20 @@ Finds the first occurrence of the regular expression \fIrx\fR, starting at posit Returns the position of the next match, or -1 if \fIrx\fR was not found. .PP \fBWarning:\fR If you want to apply this function repeatedly to the same string it is more efficient to convert the string to a TQString and apply the function to that. -.SH "int TQCString::findRev ( char c, int index = -1, bool cs = TRUE ) const" +.SH "int TQCString::findRev ( char c, int index = -1, bool cs = true ) const" Finds the first occurrence of the character \fIc\fR, starting at position \fIindex\fR and searching backwards. .PP -The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. +The search is case sensitive if \fIcs\fR is true, or case insensitive if \fIcs\fR is false. .PP Returns the position of \fIc\fR, or -1 if \fIc\fR could not be found. .PP See also Note on character comparisons. -.SH "int TQCString::findRev ( const char * str, int index = -1, bool cs = TRUE ) const" +.SH "int TQCString::findRev ( const char * str, int index = -1, bool cs = true ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Finds the first occurrence of the string \fIstr\fR, starting at position \fIindex\fR and searching backwards. .PP -The search is case sensitive if \fIcs\fR is TRUE, or case insensitive if \fIcs\fR is FALSE. +The search is case sensitive if \fIcs\fR is true, or case insensitive if \fIcs\fR is false. .PP Returns the position of \fIstr\fR, or -1 if \fIstr\fR could not be found. .PP @@ -506,13 +506,13 @@ If \fIindex\fR is beyond the end of the string, the string is padded with spaces .br .fi .SH "bool TQCString::isEmpty () const" -Returns TRUE if the string is empty, i.e. if length() == 0; otherwise returns FALSE. An empty string is not always a null string. +Returns true if the string is empty, i.e. if length() == 0; otherwise returns false. An empty string is not always a null string. .PP See example in isNull(). .PP See also isNull(), length(), and size(). .SH "bool TQCString::isNull () const" -Returns TRUE if the string is null, i.e. if data() == 0; otherwise returns FALSE. A null string is also an empty string. +Returns true if the string is null, i.e. if data() == 0; otherwise returns false. A null string is also an empty string. .PP Example: .PP @@ -522,13 +522,13 @@ Example: .br TQCString b == ""; // b.data() == "", b.size() == 1, b.length() == 0 .br - a.isNull(); // TRUE because a.data() == 0 + a.isNull(); // true because a.data() == 0 .br - a.isEmpty(); // TRUE because a.length() == 0 + a.isEmpty(); // true because a.length() == 0 .br - b.isNull(); // FALSE because b.data() == "" + b.isNull(); // false because b.data() == "" .br - b.isEmpty(); // TRUE because b.length() == 0 + b.isEmpty(); // true because b.length() == 0 .br .fi .PP @@ -551,10 +551,10 @@ Example: See also right() and mid(). .PP Example: network/networkprotocol/nntp.cpp. -.SH "TQCString TQCString::leftJustify ( uint width, char fill = ' ', bool truncate = FALSE ) const" +.SH "TQCString TQCString::leftJustify ( uint width, char fill = ' ', bool truncate = false ) const" Returns a string of length \fIwidth\fR (plus one for the terminating '\0') that contains this string padded with the \fIfill\fR character. .PP -If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is FALSE (the default), then the returned string is a copy of the string. If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is TRUE, then the returned string is a left(\fIwidth\fR). +If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is false (the default), then the returned string is a copy of the string. If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is true, then the returned string is a left(\fIwidth\fR). .PP Example: .PP @@ -757,10 +757,10 @@ Example: See also left() and mid(). .PP Example: network/networkprotocol/nntp.cpp. -.SH "TQCString TQCString::rightJustify ( uint width, char fill = ' ', bool truncate = FALSE ) const" +.SH "TQCString TQCString::rightJustify ( uint width, char fill = ' ', bool truncate = false ) const" Returns a string of length \fIwidth\fR (plus one for the terminating '\0') that contains zero or more of the \fIfill\fR character followed by this string. .PP -If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is FALSE (the default), then the returned string is a copy of the string. If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is TRUE, then the returned string is a left(\fIwidth\fR). +If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is false (the default), then the returned string is a copy of the string. If the length of the string exceeds \fIwidth\fR and \fItruncate\fR is true, then the returned string is a left(\fIwidth\fR). .PP Example: .PP @@ -776,7 +776,7 @@ See also leftJustify(). .SH "bool TQCString::setExpand ( uint index, char c )" Sets the character at position \fIindex\fR to \fIc\fR and expands the string if necessary, padding with spaces. .PP -Returns FALSE if \fIindex\fR was out of range and the string could not be expanded; otherwise returns TRUE. +Returns false if \fIindex\fR was out of range and the string could not be expanded; otherwise returns true. .SH "TQCString & TQCString::setNum ( double n, char f = 'g', int prec = 6 )" Sets the string to the string representation of the number \fIn\fR and returns a reference to the string. .PP @@ -867,35 +867,35 @@ See also simplifyWhiteSpace(). .SH "double TQCString::toDouble ( bool * ok = 0 ) const" Returns the string converted to a \fCdouble\fR value. .PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +If \fIok\fR is not 0: \fI*ok\fR is set to false if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to true. .SH "float TQCString::toFloat ( bool * ok = 0 ) const" Returns the string converted to a \fCfloat\fR value. .PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +If \fIok\fR is not 0: \fI*ok\fR is set to false if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to true. .SH "int TQCString::toInt ( bool * ok = 0 ) const" Returns the string converted to a \fCint\fR value. .PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +If \fIok\fR is not 0: \fI*ok\fR is set to false if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to true. .SH "long TQCString::toLong ( bool * ok = 0 ) const" Returns the string converted to a \fClong\fR value. .PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +If \fIok\fR is not 0: \fI*ok\fR is set to false if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to true. .SH "short TQCString::toShort ( bool * ok = 0 ) const" Returns the string converted to a \fCshort\fR value. .PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, is out of range, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +If \fIok\fR is not 0: \fI*ok\fR is set to false if the string is not a number, is out of range, or if it has trailing garbage; otherwise \fI*ok\fR is set to true. .SH "uint TQCString::toUInt ( bool * ok = 0 ) const" Returns the string converted to an \fCunsigned int\fR value. .PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +If \fIok\fR is not 0: \fI*ok\fR is set to false if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to true. .SH "ulong TQCString::toULong ( bool * ok = 0 ) const" Returns the string converted to an \fCunsigned long\fR value. .PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +If \fIok\fR is not 0: \fI*ok\fR is set to false if the string is not a number, or if it has trailing garbage; otherwise \fI*ok\fR is set to true. .SH "ushort TQCString::toUShort ( bool * ok = 0 ) const" Returns the string converted to an \fCunsigned short\fR value. .PP -If \fIok\fR is not 0: \fI*ok\fR is set to FALSE if the string is not a number, is out of range, or if it has trailing garbage; otherwise \fI*ok\fR is set to TRUE. +If \fIok\fR is not 0: \fI*ok\fR is set to false if the string is not a number, is out of range, or if it has trailing garbage; otherwise \fI*ok\fR is set to true. .SH "bool TQCString::truncate ( uint pos )" Truncates the string at position \fIpos\fR. .PP @@ -928,19 +928,19 @@ Example: See also lower() and Note on character comparisons. .SH RELATED FUNCTION DOCUMENTATION .SH "bool operator!= ( const TQCString & s1, const TQCString & s2 )" -Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. +Returns true if \fIs1\fR and \fIs2\fR are different; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. .SH "bool operator!= ( const TQCString & s1, const char * s2 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. +Returns true if \fIs1\fR and \fIs2\fR are different; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. .SH "bool operator!= ( const char * s1, const TQCString & s2 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if \fIs1\fR and \fIs2\fR are different; otherwise returns FALSE. +Returns true if \fIs1\fR and \fIs2\fR are different; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) != 0. .SH "const TQCString operator+ ( const TQCString & s1, const TQCString & s2 )" @@ -962,7 +962,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Returns a string which consists of the concatenation of \fIc\fR and \fIs\fR. .SH "bool operator< ( const TQCString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is less than \fIs2\fR; otherwise returns FALSE. +Returns true if \fIs1\fR is less than \fIs2\fR; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) < 0. .PP @@ -970,7 +970,7 @@ See also Note on character comparisons. .SH "bool operator< ( const char * s1, const TQCString & s2 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if \fIs1\fR is less than \fIs2\fR; otherwise returns FALSE. +Returns true if \fIs1\fR is less than \fIs2\fR; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) < 0. .PP @@ -980,7 +980,7 @@ Writes string \fIstr\fR to the stream \fIs\fR. .PP See also Format of the TQDataStream operators. .SH "bool operator<= ( const TQCString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is less than or equal to \fIs2\fR; otherwise returns FALSE. +Returns true if \fIs1\fR is less than or equal to \fIs2\fR; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) <= 0. .PP @@ -988,29 +988,29 @@ See also Note on character comparisons. .SH "bool operator<= ( const char * s1, const TQCString & s2 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if \fIs1\fR is less than or equal to \fIs2\fR; otherwise returns FALSE. +Returns true if \fIs1\fR is less than or equal to \fIs2\fR; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) <= 0. .PP See also Note on character comparisons. .SH "bool operator== ( const TQCString & s1, const TQCString & s2 )" -Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. +Returns true if \fIs1\fR and \fIs2\fR are equal; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. .SH "bool operator== ( const TQCString & s1, const char * s2 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. +Returns true if \fIs1\fR and \fIs2\fR are equal; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. .SH "bool operator== ( const char * s1, const TQCString & s2 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if \fIs1\fR and \fIs2\fR are equal; otherwise returns FALSE. +Returns true if \fIs1\fR and \fIs2\fR are equal; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) == 0. .SH "bool operator> ( const TQCString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is greater than \fIs2\fR; otherwise returns FALSE. +Returns true if \fIs1\fR is greater than \fIs2\fR; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) > 0. .PP @@ -1018,13 +1018,13 @@ See also Note on character comparisons. .SH "bool operator> ( const char * s1, const TQCString & s2 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if \fIs1\fR is greater than \fIs2\fR; otherwise returns FALSE. +Returns true if \fIs1\fR is greater than \fIs2\fR; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) > 0. .PP See also Note on character comparisons. .SH "bool operator>= ( const TQCString & s1, const char * s2 )" -Returns TRUE if \fIs1\fR is greater than or equal to \fIs2\fR; otherwise returns FALSE. +Returns true if \fIs1\fR is greater than or equal to \fIs2\fR; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) >= 0. .PP @@ -1032,7 +1032,7 @@ See also Note on character comparisons. .SH "bool operator>= ( const char * s1, const TQCString & s2 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if \fIs1\fR is greater than or equal to \fIs2\fR; otherwise returns FALSE. +Returns true if \fIs1\fR is greater than or equal to \fIs2\fR; otherwise returns false. .PP Equivalent to qstrcmp(\fIs1\fR, \fIs2\fR) >= 0. .PP |