diff options
Diffstat (limited to 'doc/man/man3/tqsettings.3qt')
| -rw-r--r-- | doc/man/man3/tqsettings.3qt | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/man/man3/tqsettings.3qt b/doc/man/man3/tqsettings.3qt index 7b0dd97f7..76320600f 100644 --- a/doc/man/man3/tqsettings.3qt +++ b/doc/man/man3/tqsettings.3qt @@ -44,22 +44,22 @@ QSettings \- Persistent platform-independent application settings .BI "bool \fBwriteEntry\fR ( const TQString & key, const TQString & value )" .br .ti -1c -.BI "bool \fBwriteEntry\fR ( const TQString & key, const QStringList & value )" +.BI "bool \fBwriteEntry\fR ( const TQString & key, const TQStringList & value )" .br .ti -1c -.BI "bool writeEntry ( const TQString & key, const QStringList & value, const TQChar & separator ) \fI(obsolete)\fR" +.BI "bool writeEntry ( const TQString & key, const TQStringList & value, const TQChar & separator ) \fI(obsolete)\fR" .br .ti -1c -.BI "QStringList \fBentryList\fR ( const TQString & key ) const" +.BI "TQStringList \fBentryList\fR ( const TQString & key ) const" .br .ti -1c -.BI "QStringList \fBsubkeyList\fR ( const TQString & key ) const" +.BI "TQStringList \fBsubkeyList\fR ( const TQString & key ) const" .br .ti -1c -.BI "QStringList \fBreadListEntry\fR ( const TQString & key, bool * ok = 0 ) const" +.BI "TQStringList \fBreadListEntry\fR ( const TQString & key, bool * ok = 0 ) const" .br .ti -1c -.BI "QStringList readListEntry ( const TQString & key, const TQChar & separator, bool * ok = 0 ) const \fI(obsolete)\fR" +.BI "TQStringList readListEntry ( const TQString & key, const TQChar & separator, bool * ok = 0 ) const \fI(obsolete)\fR" .br .ti -1c .BI "TQString \fBreadEntry\fR ( const TQString & key, const TQString & def = TQString::null, bool * ok = 0 ) const" @@ -197,22 +197,22 @@ You can get a list of entry-holding keys by calling entryList(), and a list of k .PP .nf .br - QStringList keys = settings.entryList( "/MyApplication" ); + TQStringList keys = settings.entryList( "/MyApplication" ); .br // keys contains 'background color' and 'foreground color'. .br .br - QStringList keys = settings.entryList( "/MyApplication/recent files" ); + TQStringList keys = settings.entryList( "/MyApplication/recent files" ); .br // keys contains '1', '2' and '3'. .br .br - QStringList subkeys = settings.subkeyList( "/MyApplication" ); + TQStringList subkeys = settings.subkeyList( "/MyApplication" ); .br // subkeys contains 'geometry' and 'recent files' .br .br - QStringList subkeys = settings.subkeyList( "/MyApplication/recent files" ); + TQStringList subkeys = settings.subkeyList( "/MyApplication/recent files" ); .br // subkeys is empty. .br @@ -325,7 +325,7 @@ Undo previous calls to beginGroup(). Note that a single beginGroup("a/b/c") is u settings.endGroup(); .br .fi -.SH "QStringList QSettings::entryList ( const TQString & key ) const" +.SH "TQStringList QSettings::entryList ( const TQString & key ) const" Returns a list of the keys which contain entries under \fIkey\fR. Does \fInot\fR return any keys that contain subkeys. .PP Example settings: @@ -348,7 +348,7 @@ Example settings: .PP .nf .br - QStringList keys = settings.entryList( "/MyCompany/MyApplication" ); + TQStringList keys = settings.entryList( "/MyCompany/MyApplication" ); .br .fi .PP @@ -447,16 +447,16 @@ See also readEntry(), readNumEntry(), readBoolEntry(), writeEntry(), and removeE 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 "QStringList QSettings::readListEntry ( const TQString & key, bool * ok = 0 ) const" +.SH "TQStringList QSettings::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. .PP Note that if you want to iterate over the list, you should iterate over a copy, e.g. .PP .nf .br - QStringList list = mySettings.readListEntry( "recentfiles" ); + TQStringList list = mySettings.readListEntry( "recentfiles" ); .br - QStringList::Iterator it = list.begin(); + TQStringList::Iterator it = list.begin(); .br while( it != list.end() ) { .br @@ -468,23 +468,23 @@ Note that if you want to iterate over the list, you should iterate over a copy, .br .fi .PP -See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and QStringList::split(). -.SH "QStringList QSettings::readListEntry ( const TQString & key, const TQChar & separator, bool * ok = 0 ) const" +See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and TQStringList::split(). +.SH "TQStringList QSettings::readListEntry ( const TQString & key, const TQChar & separator, bool * ok = 0 ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .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 QStringList by calling QStringList::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, QStringList::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. +\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 Note that if you want to iterate over the list, you should iterate over a copy, e.g. .PP .nf .br - QStringList list = mySettings.readListEntry( "size", " " ); + TQStringList list = mySettings.readListEntry( "size", " " ); .br - QStringList::Iterator it = list.begin(); + TQStringList::Iterator it = list.begin(); .br while( it != list.end() ) { .br @@ -496,7 +496,7 @@ Note that if you want to iterate over the list, you should iterate over a copy, .br .fi .PP -See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and QStringList::split(). +See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and TQStringList::split(). .SH "int QSettings::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. .PP @@ -523,7 +523,7 @@ The \fIproduct\fR should be the official name of the product. The \fIscope\fR should be QSettings::User for user-specific settings, or QSettings::Global for system-wide settings (generally these will be read-only to many users). .PP Not all information is relevant on all systems. -.SH "QStringList QSettings::subkeyList ( const TQString & key ) const" +.SH "TQStringList QSettings::subkeyList ( const TQString & key ) const" Returns a list of the keys which contain subkeys under \fIkey\fR. Does \fInot\fR return any keys that contain entries. .PP Example settings: @@ -552,7 +552,7 @@ Example settings: .PP .nf .br - QStringList keys = settings.subkeyList( "/MyCompany/MyApplication" ); + TQStringList keys = settings.subkeyList( "/MyCompany/MyApplication" ); .br .fi .PP @@ -607,7 +607,7 @@ Writes the string entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is created 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 QSettings::writeEntry ( const TQString & key, const QStringList & value )" +.SH "bool QSettings::writeEntry ( const TQString & key, const TQStringList & value )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .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. @@ -615,18 +615,18 @@ Writes the string list entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is cr 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 QSettings::writeEntry ( const TQString & key, const QStringList & value, const TQChar & separator )" +.SH "bool QSettings::writeEntry ( const TQString & key, const TQStringList & value, const TQChar & separator )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .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. The list is stored as a sequence of strings separated by \fIseparator\fR (using QStringList::join()), so none of the strings in the list should contain the separator. If the list is empty or null the key's value will be an empty string. +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. The list is stored as a sequence of strings separated by \fIseparator\fR (using TQStringList::join()), so none of the strings in the list should contain the separator. If the list is empty or null the key's value will be an empty string. .PP -\fBWarning:\fR The list should not contain empty or null strings, as readListEntry() will use QStringList::split() to recreate the list. As the documentation states, QStringList::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. +\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. .PP -See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), removeEntry(), and QStringList::join(). +See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), removeEntry(), and TQStringList::join(). .SH "SEE ALSO" .BR http://doc.trolltech.com/ntqsettings.html |