diff options
Diffstat (limited to 'doc/man/man3/tqsettings.3qt')
| -rw-r--r-- | doc/man/man3/tqsettings.3qt | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/man/man3/tqsettings.3qt b/doc/man/man3/tqsettings.3qt index da46c8e22..5379432d0 100644 --- a/doc/man/man3/tqsettings.3qt +++ b/doc/man/man3/tqsettings.3qt @@ -71,7 +71,7 @@ TQSettings \- Persistent platform-independent application settings .BI "double \fBreadDoubleEntry\fR ( const TQString & key, double def = 0, bool * ok = 0 ) const" .br .ti -1c -.BI "bool \fBreadBoolEntry\fR ( const TQString & key, bool def = FALSE, bool * ok = 0 ) const" +.BI "bool \fBreadBoolEntry\fR ( const TQString & key, bool def = false, bool * ok = 0 ) const" .br .ti -1c .BI "bool \fBremoveEntry\fR ( const TQString & key )" @@ -384,7 +384,7 @@ HKEY_LOCAL_MACHINE/Software/MyApplication .br settings.insertSearchPath( TQSettings::Windows, "/MyCompany" ); .br - settings.writeEntry( "/MyApplication/Tip of the day", TRUE ); + settings.writeEntry( "/MyApplication/Tip of the day", true ); .br .fi The code above will write the subkey "Tip of the day" into the \fIfirst\fR of the registry folders listed below that is found and for which the user has write permission. <ol type=1> @@ -435,20 +435,20 @@ Settings under Unix are stored in files whose names are based on the first subke See also removeSearchPath(). .PP Example: chart/chartform.cpp. -.SH "bool TQSettings::readBoolEntry ( const TQString & key, bool def = FALSE, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns a bool, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. +.SH "bool TQSettings::readBoolEntry ( const TQString & key, bool def = false, bool * ok = 0 ) const" +Reads the entry specified by \fIkey\fR, and returns a bool, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to true if the key was read, false otherwise. .PP See also readEntry(), readNumEntry(), readDoubleEntry(), writeEntry(), and removeEntry(). .SH "double TQSettings::readDoubleEntry ( const TQString & key, double def = 0, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns a double, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. +Reads the entry specified by \fIkey\fR, and returns a double, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to true if the key was read, false otherwise. .PP See also readEntry(), readNumEntry(), readBoolEntry(), writeEntry(), and removeEntry(). .SH "TQString TQSettings::readEntry ( const TQString & key, const TQString & def = TQString::null, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns a TQString, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. +Reads the entry specified by \fIkey\fR, and returns a TQString, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to true if the key was read, false otherwise. .PP See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), and removeEntry(). .SH "TQStringList TQSettings::readListEntry ( const TQString & key, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR as a string. If \fIok\fR is not 0, \fI*ok\fR is set to TRUE if the key was read, otherwise \fI*ok\fR is set to FALSE. +Reads the entry specified by \fIkey\fR as a string. If \fIok\fR is not 0, \fI*ok\fR is set to true if the key was read, otherwise \fI*ok\fR is set to false. .PP Note that if you want to iterate over the list, you should iterate over a copy, e.g. .PP @@ -474,7 +474,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP -Reads the entry specified by \fIkey\fR as a string. The \fIseparator\fR is used to create a TQStringList by calling TQStringList::split(\fIseparator\fR, entry). If \fIok\fR is not 0: \fI*ok\fR is set to TRUE if the key was read, otherwise \fI*ok\fR is set to FALSE. +Reads the entry specified by \fIkey\fR as a string. The \fIseparator\fR is used to create a TQStringList by calling TQStringList::split(\fIseparator\fR, entry). If \fIok\fR is not 0: \fI*ok\fR is set to true if the key was read, otherwise \fI*ok\fR is set to false. .PP \fBWarning:\fR As the documentation states, TQStringList::split() will omit empty strings from the list. Because of this, it is impossible to retrieve identical list data with this function. We recommend using the readListEntry() and writeEntry() overloads that do not take a \fIseparator\fR argument. .PP @@ -498,7 +498,7 @@ Note that if you want to iterate over the list, you should iterate over a copy, .PP See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and TQStringList::split(). .SH "int TQSettings::readNumEntry ( const TQString & key, int def = 0, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns an integer, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to TRUE if the key was read, FALSE otherwise. +Reads the entry specified by \fIkey\fR, and returns an integer, or the default value, \fIdef\fR, if the entry couldn't be read. If \fIok\fR is non-null, *ok is set to true if the key was read, false otherwise. .PP See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), and removeEntry(). .SH "bool TQSettings::removeEntry ( const TQString & key )" @@ -576,7 +576,7 @@ See also entryList(). .SH "bool TQSettings::writeEntry ( const TQString & key, bool value )" Writes the boolean entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. .PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. +If an error occurs the settings are left unchanged and false is returned; otherwise true is returned. .PP \fBWarning:\fR On certain platforms, keys are required to contain at least two components (e.g., "/foo/bar"). This limitation does not apply to TQt 4. .PP @@ -588,7 +588,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Writes the double entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. .PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. +If an error occurs the settings are left unchanged and false is returned; otherwise true is returned. .PP See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). .SH "bool TQSettings::writeEntry ( const TQString & key, int value )" @@ -596,7 +596,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Writes the integer entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. .PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. +If an error occurs the settings are left unchanged and false is returned; otherwise true is returned. .PP See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). .SH "bool TQSettings::writeEntry ( const TQString & key, const TQString & value )" @@ -604,7 +604,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Writes the string entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. If \fIvalue\fR is an empty string or a null string the key's value will be an empty string. .PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise TRUE is returned. +If an error occurs the settings are left unchanged and false is returned; otherwise true is returned. .PP See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). .SH "bool TQSettings::writeEntry ( const TQString & key, const TQStringList & value )" @@ -612,7 +612,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Writes the string list entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created if it doesn't exist. Any previous value is overwritten by \fIvalue\fR. .PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise returns TRUE. +If an error occurs the settings are left unchanged and false is returned; otherwise returns true. .PP See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). .SH "bool TQSettings::writeEntry ( const TQString & key, const TQStringList & value, const TQChar & separator )" @@ -624,7 +624,7 @@ Writes the string list entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is cr .PP \fBWarning:\fR The list should not contain empty or null strings, as readListEntry() will use TQStringList::split() to recreate the list. As the documentation states, TQStringList::split() will omit empty strings from the list. Because of this, it is impossible to retrieve identical list data that is stored with this function. We recommend using the writeEntry() and readListEntry() overloads that do not take a \fIseparator\fR argument. .PP -If an error occurs the settings are left unchanged and FALSE is returned; otherwise returns TRUE. +If an error occurs the settings are left unchanged and false is returned; otherwise returns true. .PP See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), removeEntry(), and TQStringList::join(). |