diff options
Diffstat (limited to 'doc/man/man3/tqsettings.3qt')
| -rw-r--r-- | doc/man/man3/tqsettings.3qt | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/doc/man/man3/tqsettings.3qt b/doc/man/man3/tqsettings.3qt index 451d8bab..7b0dd97f 100644 --- a/doc/man/man3/tqsettings.3qt +++ b/doc/man/man3/tqsettings.3qt @@ -32,61 +32,61 @@ QSettings \- Persistent platform-independent application settings .BI "\fB~QSettings\fR ()" .br .ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, bool value )" +.BI "bool \fBwriteEntry\fR ( const TQString & key, bool value )" .br .ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, double value )" +.BI "bool \fBwriteEntry\fR ( const TQString & key, double value )" .br .ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, int value )" +.BI "bool \fBwriteEntry\fR ( const TQString & key, int value )" .br .ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, const QString & value )" +.BI "bool \fBwriteEntry\fR ( const TQString & key, const TQString & value )" .br .ti -1c -.BI "bool \fBwriteEntry\fR ( const QString & key, const QStringList & value )" +.BI "bool \fBwriteEntry\fR ( const TQString & key, const QStringList & value )" .br .ti -1c -.BI "bool writeEntry ( const QString & key, const QStringList & value, const QChar & separator ) \fI(obsolete)\fR" +.BI "bool writeEntry ( const TQString & key, const QStringList & value, const TQChar & separator ) \fI(obsolete)\fR" .br .ti -1c -.BI "QStringList \fBentryList\fR ( const QString & key ) const" +.BI "QStringList \fBentryList\fR ( const TQString & key ) const" .br .ti -1c -.BI "QStringList \fBsubkeyList\fR ( const QString & key ) const" +.BI "QStringList \fBsubkeyList\fR ( const TQString & key ) const" .br .ti -1c -.BI "QStringList \fBreadListEntry\fR ( const QString & key, bool * ok = 0 ) const" +.BI "QStringList \fBreadListEntry\fR ( const TQString & key, bool * ok = 0 ) const" .br .ti -1c -.BI "QStringList readListEntry ( const QString & key, const QChar & separator, bool * ok = 0 ) const \fI(obsolete)\fR" +.BI "QStringList readListEntry ( const TQString & key, const TQChar & separator, bool * ok = 0 ) const \fI(obsolete)\fR" .br .ti -1c -.BI "QString \fBreadEntry\fR ( const QString & key, const QString & def = QString::null, bool * ok = 0 ) const" +.BI "TQString \fBreadEntry\fR ( const TQString & key, const TQString & def = TQString::null, bool * ok = 0 ) const" .br .ti -1c -.BI "int \fBreadNumEntry\fR ( const QString & key, int def = 0, bool * ok = 0 ) const" +.BI "int \fBreadNumEntry\fR ( const TQString & key, int def = 0, bool * ok = 0 ) const" .br .ti -1c -.BI "double \fBreadDoubleEntry\fR ( const QString & key, double def = 0, bool * ok = 0 ) const" +.BI "double \fBreadDoubleEntry\fR ( const TQString & key, double def = 0, bool * ok = 0 ) const" .br .ti -1c -.BI "bool \fBreadBoolEntry\fR ( const QString & 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 QString & key )" +.BI "bool \fBremoveEntry\fR ( const TQString & key )" .br .ti -1c -.BI "void \fBinsertSearchPath\fR ( System s, const QString & path )" +.BI "void \fBinsertSearchPath\fR ( System s, const TQString & path )" .br .ti -1c -.BI "void \fBremoveSearchPath\fR ( System s, const QString & path )" +.BI "void \fBremoveSearchPath\fR ( System s, const TQString & path )" .br .ti -1c -.BI "void \fBsetPath\fR ( const QString & domain, const QString & product, Scope scope = Global )" +.BI "void \fBsetPath\fR ( const TQString & domain, const TQString & product, Scope scope = Global )" .br .ti -1c -.BI "void \fBbeginGroup\fR ( const QString & group )" +.BI "void \fBbeginGroup\fR ( const TQString & group )" .br .ti -1c .BI "void \fBendGroup\fR ()" @@ -95,7 +95,7 @@ QSettings \- Persistent platform-independent application settings .BI "void \fBresetGroup\fR ()" .br .ti -1c -.BI "QString \fBgroup\fR () const" +.BI "TQString \fBgroup\fR () const" .br .in -1c .SH DESCRIPTION @@ -141,7 +141,7 @@ A typical usage pattern for reading settings at application startup: settings.setPath( "MyCompany.com", "MyApplication" ); .br .br - QString bgColor = settings.readEntry( "/colors/background", "white" ); + TQString bgColor = settings.readEntry( "/colors/background", "white" ); .br int width = settings.readNumEntry( "/geometry/width", 640 ); .br @@ -297,7 +297,7 @@ Creates a settings object. If \fIformat\fR is 'Ini' the settings will be stored Be aware that you must call setPath() or insertSearchPath() before you can use the QSettings object. .SH "QSettings::~QSettings ()" Destroys the settings object. All modifications made to the settings will automatically be saved. -.SH "void QSettings::beginGroup ( const QString & group )" +.SH "void QSettings::beginGroup ( const TQString & group )" Appends \fIgroup\fR to the current key prefix. .PP .nf @@ -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 QString & key ) const" +.SH "QStringList 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: @@ -357,11 +357,11 @@ In the above example, \fCkeys\fR will contain 'background color' and 'foreground To access the geometry values, you could either use subkeyList() to read the keys then read each entry, or simply read each entry directly by specifying its full key, e.g." /MyCompany/MyApplication/geometry/y". .PP See also subkeyList(). -.SH "QString QSettings::group () const" +.SH "TQString QSettings::group () const" Returns the current key prefix, or a null string if there is no key prefix set. .PP See also beginGroup(). -.SH "void QSettings::insertSearchPath ( System s, const QString & path )" +.SH "void QSettings::insertSearchPath ( System s, const TQString & path )" Inserts \fIpath\fR into the settings search path. The semantics of \fIpath\fR depends on the system \fIs\fR. It is usually easier and better to use setPath() instead of this function. .PP When \fIs\fR is \fIWindows\fR and the execution environment is \fInot\fR Windows the function does nothing. Similarly when \fIs\fR is \fIUnix\fR and the execution environment is \fInot\fR Unix the function does nothing. @@ -435,19 +435,19 @@ 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 QSettings::readBoolEntry ( const QString & key, bool def = FALSE, bool * ok = 0 ) const" +.SH "bool QSettings::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 QSettings::readDoubleEntry ( const QString & key, double def = 0, bool * ok = 0 ) const" +.SH "double QSettings::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. .PP See also readEntry(), readNumEntry(), readBoolEntry(), writeEntry(), and removeEntry(). -.SH "QString QSettings::readEntry ( const QString & key, const QString & def = QString::null, bool * ok = 0 ) const" -Reads the entry specified by \fIkey\fR, and returns a QString, 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 "TQString QSettings::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. .PP See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), and removeEntry(). -.SH "QStringList QSettings::readListEntry ( const QString & key, bool * ok = 0 ) const" +.SH "QStringList 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. @@ -469,7 +469,7 @@ Note that if you want to iterate over the list, you should iterate over a copy, .fi .PP See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and QStringList::split(). -.SH "QStringList QSettings::readListEntry ( const QString & key, const QChar & separator, bool * ok = 0 ) const" +.SH "QStringList 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. @@ -497,23 +497,23 @@ Note that if you want to iterate over the list, you should iterate over a copy, .fi .PP See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), removeEntry(), and QStringList::split(). -.SH "int QSettings::readNumEntry ( const QString & key, int def = 0, bool * ok = 0 ) const" +.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 See also readEntry(), readDoubleEntry(), readBoolEntry(), writeEntry(), and removeEntry(). -.SH "bool QSettings::removeEntry ( const QString & key )" +.SH "bool QSettings::removeEntry ( const TQString & key )" Removes the entry specified by \fIkey\fR. .PP Returns true if the entry was successfully removed; otherwise returns false. Note that removing the last entry in any given folder, will also remove the folder. .PP See also readEntry() and writeEntry(). -.SH "void QSettings::removeSearchPath ( System s, const QString & path )" +.SH "void QSettings::removeSearchPath ( System s, const TQString & path )" Removes all occurrences of \fIpath\fR (using exact matching) from the settings search path for system \fIs\fR. Note that the default search paths cannot be removed. .PP See also insertSearchPath(). .SH "void QSettings::resetGroup ()" Set the current key prefix to the empty string. -.SH "void QSettings::setPath ( const QString & domain, const QString & product, Scope scope = Global )" +.SH "void QSettings::setPath ( const TQString & domain, const TQString & product, Scope scope = Global )" Insert platform-dependent paths from platform-independent information. .PP The \fIdomain\fR should be an Internet domain name controlled by the producer of the software, eg. Trolltech products use "trolltech.com". @@ -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 QString & key ) const" +.SH "QStringList 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: @@ -573,7 +573,7 @@ will return an empty list. This happens because a key like is written to the file \fI"mycompanyrc"\fR, under the section \fI[MyApplication]\fR. This call is therefore a request to list the sections in an ini file, which is not supported in this version of QSettings. This is a known issue which will be fixed in Qt-4. .PP See also entryList(). -.SH "bool QSettings::writeEntry ( const QString & key, bool value )" +.SH "bool QSettings::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. @@ -583,7 +583,7 @@ If an error occurs the settings are left unchanged and FALSE is returned; otherw See also readListEntry(), readNumEntry(), readDoubleEntry(), readBoolEntry(), and removeEntry(). .PP Example: chart/chartform.cpp. -.SH "bool QSettings::writeEntry ( const QString & key, double value )" +.SH "bool QSettings::writeEntry ( const TQString & key, double value )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .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. @@ -591,7 +591,7 @@ Writes the double 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 QString & key, int value )" +.SH "bool QSettings::writeEntry ( const TQString & key, int value )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .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. @@ -599,7 +599,7 @@ Writes the integer entry \fIvalue\fR into key \fIkey\fR. The \fIkey\fR is create 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 QString & key, const QString & value )" +.SH "bool QSettings::writeEntry ( const TQString & key, const TQString & value )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .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. @@ -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 QString & key, const QStringList & value )" +.SH "bool QSettings::writeEntry ( const TQString & key, const QStringList & 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,7 +615,7 @@ 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 QString & key, const QStringList & value, const QChar & separator )" +.SH "bool QSettings::writeEntry ( const TQString & key, const QStringList & 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. |