diff options
Diffstat (limited to 'doc/html/tqsettings.html')
| -rw-r--r-- | doc/html/tqsettings.html | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/doc/html/tqsettings.html b/doc/html/tqsettings.html index 93c09fa88..350baa0e2 100644 --- a/doc/html/tqsettings.html +++ b/doc/html/tqsettings.html @@ -55,7 +55,7 @@ body { background: #ffffff; color: black; } <li class=fn>TQString <a href="#readEntry"><b>readEntry</b></a> ( const TQString & key, const TQString & def = TQString::null, bool * ok = 0 ) const</li> <li class=fn>int <a href="#readNumEntry"><b>readNumEntry</b></a> ( const TQString & key, int def = 0, bool * ok = 0 ) const</li> <li class=fn>double <a href="#readDoubleEntry"><b>readDoubleEntry</b></a> ( const TQString & key, double def = 0, bool * ok = 0 ) const</li> -<li class=fn>bool <a href="#readBoolEntry"><b>readBoolEntry</b></a> ( const TQString & key, bool def = FALSE, bool * ok = 0 ) const</li> +<li class=fn>bool <a href="#readBoolEntry"><b>readBoolEntry</b></a> ( const TQString & key, bool def = false, bool * ok = 0 ) const</li> <li class=fn>bool <a href="#removeEntry"><b>removeEntry</b></a> ( const TQString & key )</li> <li class=fn>void <a href="#insertSearchPath"><b>insertSearchPath</b></a> ( System s, const TQString & path )</li> <li class=fn>void <a href="#removeSearchPath"><b>removeSearchPath</b></a> ( System s, const TQString & path )</li> @@ -334,7 +334,7 @@ have read permission. <p> <pre> TQSettings settings; settings.<a href="#insertSearchPath">insertSearchPath</a>( TQSettings::<a href="#System-enum">Windows</a>, "/MyCompany" ); - settings.<a href="#writeEntry">writeEntry</a>( "/MyApplication/Tip of the day", TRUE ); + settings.<a href="#writeEntry">writeEntry</a>( "/MyApplication/Tip of the day", true ); </pre> The code above will write the subkey "Tip of the day" into the <em>first</em> of the registry folders listed below that is found and for @@ -391,12 +391,12 @@ the search path). <p> <p>Example: <a href="canvas-chart-example.html#x2890">chart/chartform.cpp</a>. -<h3 class=fn>bool <a name="readBoolEntry"></a>TQSettings::readBoolEntry ( const <a href="tqstring.html">TQString</a> & key, bool def = FALSE, bool * ok = 0 ) const +<h3 class=fn>bool <a name="readBoolEntry"></a>TQSettings::readBoolEntry ( const <a href="tqstring.html">TQString</a> & key, bool def = false, bool * ok = 0 ) const </h3> <p> Reads the entry specified by <em>key</em>, and returns a bool, or the default value, <em>def</em>, if the entry couldn't be read. -If <em>ok</em> is non-null, *ok is set to TRUE if the key was read, FALSE +If <em>ok</em> is non-null, *ok is set to true if the key was read, false otherwise. <p> <p>See also <a href="#readEntry">readEntry</a>(), <a href="#readNumEntry">readNumEntry</a>(), <a href="#readDoubleEntry">readDoubleEntry</a>(), <a href="#writeEntry">writeEntry</a>(), and <a href="#removeEntry">removeEntry</a>(). @@ -405,7 +405,7 @@ otherwise. <p> Reads the entry specified by <em>key</em>, and returns a double, or the default value, <em>def</em>, if the entry couldn't be read. -If <em>ok</em> is non-null, *ok is set to TRUE if the key was read, FALSE +If <em>ok</em> is non-null, *ok is set to true if the key was read, false otherwise. <p> <p>See also <a href="#readEntry">readEntry</a>(), <a href="#readNumEntry">readNumEntry</a>(), <a href="#readBoolEntry">readBoolEntry</a>(), <a href="#writeEntry">writeEntry</a>(), and <a href="#removeEntry">removeEntry</a>(). @@ -414,7 +414,7 @@ otherwise. <p> Reads the entry specified by <em>key</em>, and returns a <a href="tqstring.html">TQString</a>, or the default value, <em>def</em>, if the entry couldn't be read. -If <em>ok</em> is non-null, *ok is set to TRUE if the key was read, FALSE +If <em>ok</em> is non-null, *ok is set to true if the key was read, false otherwise. <p> <p>See also <a href="#readListEntry">readListEntry</a>(), <a href="#readNumEntry">readNumEntry</a>(), <a href="#readDoubleEntry">readDoubleEntry</a>(), <a href="#readBoolEntry">readBoolEntry</a>(), <a href="#writeEntry">writeEntry</a>(), and <a href="#removeEntry">removeEntry</a>(). @@ -422,8 +422,8 @@ otherwise. </h3> Reads the entry specified by <em>key</em> as a string. If <em>ok</em> is not -0, <em>*ok</em> is set to TRUE if the key was read, otherwise <em>*ok</em> is -set to FALSE. +0, <em>*ok</em> is set to true if the key was read, otherwise <em>*ok</em> is +set to false. <p> Note that if you want to iterate over the list, you should iterate over a copy, e.g. <pre> @@ -442,8 +442,8 @@ over a copy, e.g. This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> <b>This function is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. <p> Reads the entry specified by <em>key</em> as a string. The <em>separator</em> -is used to create a <a href="tqstringlist.html">TQStringList</a> by calling <a href="tqstringlist.html#split">TQStringList::split</a>(<em>separator</em>, entry). If <em>ok</em> is not 0: <em>*ok</em> is set to TRUE -if the key was read, otherwise <em>*ok</em> is set to FALSE. +is used to create a <a href="tqstringlist.html">TQStringList</a> by calling <a href="tqstringlist.html#split">TQStringList::split</a>(<em>separator</em>, entry). If <em>ok</em> is not 0: <em>*ok</em> is set to true +if the key was read, otherwise <em>*ok</em> is set to false. <p> <b>Warning:</b> 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 @@ -467,7 +467,7 @@ over a copy, e.g. <p> Reads the entry specified by <em>key</em>, and returns an integer, or the default value, <em>def</em>, if the entry couldn't be read. -If <em>ok</em> is non-null, *ok is set to TRUE if the key was read, FALSE +If <em>ok</em> is non-null, *ok is set to true if the key was read, false otherwise. <p> <p>See also <a href="#readEntry">readEntry</a>(), <a href="#readDoubleEntry">readDoubleEntry</a>(), <a href="#readBoolEntry">readBoolEntry</a>(), <a href="#writeEntry">writeEntry</a>(), and <a href="#removeEntry">removeEntry</a>(). @@ -545,8 +545,8 @@ will be fixed in TQt-4. </h3> Writes the boolean entry <em>value</em> into key <em>key</em>. The <em>key</em> is created if it doesn't exist. Any previous value is overwritten by <em>value</em>. -<p> If an error occurs the settings are left unchanged and FALSE is -returned; otherwise TRUE is returned. +<p> If an error occurs the settings are left unchanged and false is +returned; otherwise true is returned. <p> <b>Warning:</b> On certain platforms, keys are required to contain at least two components (e.g., "/foo/bar"). This limitation does not apply to TQt 4. @@ -558,8 +558,8 @@ TQt 4. This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Writes the double entry <em>value</em> into key <em>key</em>. The <em>key</em> is created if it doesn't exist. Any previous value is overwritten by <em>value</em>. -<p> If an error occurs the settings are left unchanged and FALSE is -returned; otherwise TRUE is returned. +<p> If an error occurs the settings are left unchanged and false is +returned; otherwise true is returned. <p> <p>See also <a href="#readListEntry">readListEntry</a>(), <a href="#readNumEntry">readNumEntry</a>(), <a href="#readDoubleEntry">readDoubleEntry</a>(), <a href="#readBoolEntry">readBoolEntry</a>(), and <a href="#removeEntry">removeEntry</a>(). <h3 class=fn>bool <a name="writeEntry-3"></a>TQSettings::writeEntry ( const <a href="tqstring.html">TQString</a> & key, int value ) @@ -567,8 +567,8 @@ returned; otherwise TRUE is returned. This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Writes the integer entry <em>value</em> into key <em>key</em>. The <em>key</em> is created if it doesn't exist. Any previous value is overwritten by <em>value</em>. -<p> If an error occurs the settings are left unchanged and FALSE is -returned; otherwise TRUE is returned. +<p> If an error occurs the settings are left unchanged and false is +returned; otherwise true is returned. <p> <p>See also <a href="#readListEntry">readListEntry</a>(), <a href="#readNumEntry">readNumEntry</a>(), <a href="#readDoubleEntry">readDoubleEntry</a>(), <a href="#readBoolEntry">readBoolEntry</a>(), and <a href="#removeEntry">removeEntry</a>(). <h3 class=fn>bool <a name="writeEntry-5"></a>TQSettings::writeEntry ( const <a href="tqstring.html">TQString</a> & key, const <a href="tqstring.html">TQString</a> & value ) @@ -577,8 +577,8 @@ This is an overloaded member function, provided for convenience. It behaves esse <p> Writes the string entry <em>value</em> into key <em>key</em>. The <em>key</em> is created if it doesn't exist. Any previous value is overwritten by <em>value</em>. If <em>value</em> is an empty string or a null string the key's value will be an empty string. -<p> If an error occurs the settings are left unchanged and FALSE is -returned; otherwise TRUE is returned. +<p> If an error occurs the settings are left unchanged and false is +returned; otherwise true is returned. <p> <p>See also <a href="#readListEntry">readListEntry</a>(), <a href="#readNumEntry">readNumEntry</a>(), <a href="#readDoubleEntry">readDoubleEntry</a>(), <a href="#readBoolEntry">readBoolEntry</a>(), and <a href="#removeEntry">removeEntry</a>(). <h3 class=fn>bool <a name="writeEntry-6"></a>TQSettings::writeEntry ( const <a href="tqstring.html">TQString</a> & key, const <a href="tqstringlist.html">TQStringList</a> & value ) @@ -587,8 +587,8 @@ This is an overloaded member function, provided for convenience. It behaves esse <p> Writes the string list entry <em>value</em> into key <em>key</em>. The <em>key</em> is created if it doesn't exist. Any previous value is overwritten by <em>value</em>. -<p> If an error occurs the settings are left unchanged and FALSE is -returned; otherwise returns TRUE. +<p> If an error occurs the settings are left unchanged and false is +returned; otherwise returns true. <p> <p>See also <a href="#readListEntry">readListEntry</a>(), <a href="#readNumEntry">readNumEntry</a>(), <a href="#readDoubleEntry">readDoubleEntry</a>(), <a href="#readBoolEntry">readBoolEntry</a>(), and <a href="#removeEntry">removeEntry</a>(). <h3 class=fn>bool <a name="writeEntry-7"></a>TQSettings::writeEntry ( const <a href="tqstring.html">TQString</a> & key, const <a href="tqstringlist.html">TQStringList</a> & value, const <a href="tqchar.html">TQChar</a> & separator ) @@ -608,8 +608,8 @@ 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 <a href="#writeEntry">writeEntry</a>() and readListEntry() overloads that do not take a <em>separator</em> argument. -<p> If an error occurs the settings are left unchanged and FALSE is -returned; otherwise returns TRUE. +<p> If an error occurs the settings are left unchanged and false is +returned; otherwise returns true. <p> <p>See also <a href="#readListEntry">readListEntry</a>(), <a href="#readNumEntry">readNumEntry</a>(), <a href="#readDoubleEntry">readDoubleEntry</a>(), <a href="#readBoolEntry">readBoolEntry</a>(), <a href="#removeEntry">removeEntry</a>(), and <a href="tqstringlist.html#join">TQStringList::join</a>(). <!-- eof --> |