diff options
Diffstat (limited to 'doc/html/tqdir.html')
| -rw-r--r-- | doc/html/tqdir.html | 130 |
1 files changed, 65 insertions, 65 deletions
diff --git a/doc/html/tqdir.html b/doc/html/tqdir.html index 604502d3c..0ad39734c 100644 --- a/doc/html/tqdir.html +++ b/doc/html/tqdir.html @@ -50,9 +50,9 @@ body { background: #ffffff; color: black; } <li class=fn>virtual TQString <a href="#absPath"><b>absPath</b></a> () const</li> <li class=fn>virtual TQString <a href="#canonicalPath"><b>canonicalPath</b></a> () const</li> <li class=fn>virtual TQString <a href="#dirName"><b>dirName</b></a> () const</li> -<li class=fn>virtual TQString <a href="#filePath"><b>filePath</b></a> ( const TQString & fileName, bool acceptAbsPath = TRUE ) const</li> -<li class=fn>virtual TQString <a href="#absFilePath"><b>absFilePath</b></a> ( const TQString & fileName, bool acceptAbsPath = TRUE ) const</li> -<li class=fn>virtual bool <a href="#cd"><b>cd</b></a> ( const TQString & dirName, bool acceptAbsPath = TRUE )</li> +<li class=fn>virtual TQString <a href="#filePath"><b>filePath</b></a> ( const TQString & fileName, bool acceptAbsPath = true ) const</li> +<li class=fn>virtual TQString <a href="#absFilePath"><b>absFilePath</b></a> ( const TQString & fileName, bool acceptAbsPath = true ) const</li> +<li class=fn>virtual bool <a href="#cd"><b>cd</b></a> ( const TQString & dirName, bool acceptAbsPath = true )</li> <li class=fn>virtual bool <a href="#cdUp"><b>cdUp</b></a> ()</li> <li class=fn>TQString <a href="#nameFilter"><b>nameFilter</b></a> () const</li> <li class=fn>virtual void <a href="#setNameFilter"><b>setNameFilter</b></a> ( const TQString & nameFilter )</li> @@ -70,8 +70,8 @@ body { background: #ffffff; color: black; } <li class=fn>virtual TQStringList <a href="#entryList"><b>entryList</b></a> ( const TQString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const</li> <li class=fn>virtual const TQFileInfoList * <a href="#entryInfoList-2"><b>entryInfoList</b></a> ( int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const</li> <li class=fn>virtual const TQFileInfoList * <a href="#entryInfoList"><b>entryInfoList</b></a> ( const TQString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const</li> -<li class=fn>virtual bool <a href="#mkdir"><b>mkdir</b></a> ( const TQString & dirName, bool acceptAbsPath = TRUE ) const</li> -<li class=fn>virtual bool <a href="#rmdir"><b>rmdir</b></a> ( const TQString & dirName, bool acceptAbsPath = TRUE ) const</li> +<li class=fn>virtual bool <a href="#mkdir"><b>mkdir</b></a> ( const TQString & dirName, bool acceptAbsPath = true ) const</li> +<li class=fn>virtual bool <a href="#rmdir"><b>rmdir</b></a> ( const TQString & dirName, bool acceptAbsPath = true ) const</li> <li class=fn>virtual bool <a href="#isReadable"><b>isReadable</b></a> () const</li> <li class=fn>virtual bool <a href="#exists-2"><b>exists</b></a> () const</li> <li class=fn>virtual bool <a href="#isRoot"><b>isRoot</b></a> () const</li> @@ -79,9 +79,9 @@ body { background: #ffffff; color: black; } <li class=fn>virtual void <a href="#convertToAbs"><b>convertToAbs</b></a> ()</li> <li class=fn>virtual bool <a href="#operator-eq-eq"><b>operator==</b></a> ( const TQDir & d ) const</li> <li class=fn>virtual bool <a href="#operator!-eq"><b>operator!=</b></a> ( const TQDir & d ) const</li> -<li class=fn>virtual bool <a href="#remove"><b>remove</b></a> ( const TQString & fileName, bool acceptAbsPath = TRUE )</li> -<li class=fn>virtual bool <a href="#rename"><b>rename</b></a> ( const TQString & oldName, const TQString & newName, bool acceptAbsPaths = TRUE )</li> -<li class=fn>virtual bool <a href="#exists"><b>exists</b></a> ( const TQString & name, bool acceptAbsPath = TRUE )</li> +<li class=fn>virtual bool <a href="#remove"><b>remove</b></a> ( const TQString & fileName, bool acceptAbsPath = true )</li> +<li class=fn>virtual bool <a href="#rename"><b>rename</b></a> ( const TQString & oldName, const TQString & newName, bool acceptAbsPaths = true )</li> +<li class=fn>virtual bool <a href="#exists"><b>exists</b></a> ( const TQString & name, bool acceptAbsPath = true )</li> <li class=fn>void <a href="#refresh"><b>refresh</b></a> () const</li> </ul> <h2>Static Public Members</h2> @@ -302,14 +302,14 @@ Constructs a TQDir that is a copy of the directory <em>d</em>. </h3> Destroys the TQDir frees up its resources. -<h3 class=fn><a href="tqstring.html">TQString</a> <a name="absFilePath"></a>TQDir::absFilePath ( const <a href="tqstring.html">TQString</a> & fileName, bool acceptAbsPath = TRUE ) const<tt> [virtual]</tt> +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="absFilePath"></a>TQDir::absFilePath ( const <a href="tqstring.html">TQString</a> & fileName, bool acceptAbsPath = true ) const<tt> [virtual]</tt> </h3> Returns the absolute path name of a file in the directory. Does <em>not</em> check if the file actually exists in the directory. Redundant multiple separators or "." and ".." directories in <em>fileName</em> will not be removed (see <a href="#cleanDirPath">cleanDirPath</a>()). -<p> If <em>acceptAbsPath</em> is TRUE a <em>fileName</em> starting with a +<p> If <em>acceptAbsPath</em> is true a <em>fileName</em> starting with a separator "/" will be returned without change. If <em>acceptAbsPath</em> -is FALSE an absolute path will be prepended to the fileName and +is false an absolute path will be prepended to the fileName and the resultant string returned. <p> <p>See also <a href="#filePath">filePath</a>(). @@ -331,15 +331,15 @@ canonical path does not exist (normally due to dangling symbolic links) <a href="#canonicalPath">canonicalPath</a>() returns <a href="tqstring.html#TQString-null">TQString::null</a>. <p> <p>See also <a href="#path">path</a>(), <a href="#absPath">absPath</a>(), <a href="#exists">exists</a>(), <a href="#cleanDirPath">cleanDirPath</a>(), <a href="#dirName">dirName</a>(), <a href="#absFilePath">absFilePath</a>(), and <a href="tqstring.html#isNull">TQString::isNull</a>(). -<h3 class=fn>bool <a name="cd"></a>TQDir::cd ( const <a href="tqstring.html">TQString</a> & dirName, bool acceptAbsPath = TRUE )<tt> [virtual]</tt> +<h3 class=fn>bool <a name="cd"></a>TQDir::cd ( const <a href="tqstring.html">TQString</a> & dirName, bool acceptAbsPath = true )<tt> [virtual]</tt> </h3> Changes the TQDir's directory to <em>dirName</em>. -<p> If <em>acceptAbsPath</em> is TRUE a path starting with separator "/" -will cause the function to change to the absolute directory. If <em>acceptAbsPath</em> is FALSE any number of separators at the beginning +<p> If <em>acceptAbsPath</em> is true a path starting with separator "/" +will cause the function to change to the absolute directory. If <em>acceptAbsPath</em> is false any number of separators at the beginning of <em>dirName</em> will be removed and the function will descend into <em>dirName</em>. -<p> Returns TRUE if the new directory exists and is readable; -otherwise returns FALSE. Note that the logical <a href="#cd">cd</a>() operation is +<p> Returns true if the new directory exists and is readable; +otherwise returns false. Note that the logical <a href="#cd">cd</a>() operation is not performed if the new directory does not exist. <p> Calling cd( ".." ) is equivalent to calling <a href="#cdUp">cdUp</a>(). <p> <p>See also <a href="#cdUp">cdUp</a>(), <a href="#isReadable">isReadable</a>(), <a href="#exists">exists</a>(), and <a href="#path">path</a>(). @@ -349,8 +349,8 @@ not performed if the new directory does not exist. </h3> Changes directory by moving one directory up from the TQDir's current directory. -<p> Returns TRUE if the new directory exists and is readable; -otherwise returns FALSE. Note that the logical <a href="#cdUp">cdUp</a>() operation is +<p> Returns true if the new directory exists and is readable; +otherwise returns false. Note that the logical <a href="#cdUp">cdUp</a>() operation is not performed if the new directory does not exist. <p> <p>See also <a href="#cd">cd</a>(), <a href="#isReadable">isReadable</a>(), <a href="#exists">exists</a>(), and <a href="#path">path</a>(). @@ -496,34 +496,34 @@ filtered in accordance with <a href="#setFilter">setFilter</a>() and <a href="#s exist. <p> <p>See also <a href="#entryInfoList">entryInfoList</a>(), <a href="#setNameFilter">setNameFilter</a>(), <a href="#setSorting">setSorting</a>(), and <a href="#setFilter">setFilter</a>(). -<h3 class=fn>bool <a name="exists"></a>TQDir::exists ( const <a href="tqstring.html">TQString</a> & name, bool acceptAbsPath = TRUE )<tt> [virtual]</tt> +<h3 class=fn>bool <a name="exists"></a>TQDir::exists ( const <a href="tqstring.html">TQString</a> & name, bool acceptAbsPath = true )<tt> [virtual]</tt> </h3> Checks for the existence of the file <em>name</em>. -<p> If <em>acceptAbsPath</em> is TRUE a path starting with separator "/" +<p> If <em>acceptAbsPath</em> is true a path starting with separator "/" will check the file with the absolute path. If <em>acceptAbsPath</em> is -FALSE any number of separators at the beginning of <em>name</em> will be +false any number of separators at the beginning of <em>name</em> will be removed and the resultant file name will be checked. -<p> Returns TRUE if the file exists; otherwise returns FALSE. +<p> Returns true if the file exists; otherwise returns false. <p> <p>See also <a href="tqfileinfo.html#exists">TQFileInfo::exists</a>() and <a href="tqfile.html#exists">TQFile::exists</a>(). <h3 class=fn>bool <a name="exists-2"></a>TQDir::exists () const<tt> [virtual]</tt> </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -<p> Returns TRUE if the <em>directory</em> exists; otherwise returns FALSE. +<p> Returns true if the <em>directory</em> exists; otherwise returns false. (If a file with the same name is found this function will return -FALSE). +false). <p> <p>See also <a href="tqfileinfo.html#exists">TQFileInfo::exists</a>() and <a href="tqfile.html#exists">TQFile::exists</a>(). -<h3 class=fn><a href="tqstring.html">TQString</a> <a name="filePath"></a>TQDir::filePath ( const <a href="tqstring.html">TQString</a> & fileName, bool acceptAbsPath = TRUE ) const<tt> [virtual]</tt> +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="filePath"></a>TQDir::filePath ( const <a href="tqstring.html">TQString</a> & fileName, bool acceptAbsPath = true ) const<tt> [virtual]</tt> </h3> Returns the path name of a file in the directory. Does <em>not</em> check if the file actually exists in the directory. If the TQDir is relative the returned path name will also be relative. Redundant multiple separators or "." and ".." directories in <em>fileName</em> will not be removed (see <a href="#cleanDirPath">cleanDirPath</a>()). -<p> If <em>acceptAbsPath</em> is TRUE a <em>fileName</em> starting with a +<p> If <em>acceptAbsPath</em> is true a <em>fileName</em> starting with a separator "/" will be returned without change. If <em>acceptAbsPath</em> -is FALSE an absolute path will be prepended to the fileName and +is false an absolute path will be prepended to the fileName and the resultant string returned. <p> <p>See also <a href="#absFilePath">absFilePath</a>(), <a href="#isRelative">isRelative</a>(), and <a href="#canonicalPath">canonicalPath</a>(). @@ -552,32 +552,32 @@ variable is used if it exists, otherwise rootDirPath() is used. <h3 class=fn>bool <a name="isReadable"></a>TQDir::isReadable () const<tt> [virtual]</tt> </h3> -Returns TRUE if the directory is readable <em>and</em> we can open files -by name; otherwise returns FALSE. -<p> <b>Warning:</b> A FALSE value from this function is not a guarantee that +Returns true if the directory is readable <em>and</em> we can open files +by name; otherwise returns false. +<p> <b>Warning:</b> A false value from this function is not a guarantee that files in the directory are not accessible. <p> <p>See also <a href="tqfileinfo.html#isReadable">TQFileInfo::isReadable</a>(). <p>Examples: <a href="dirview-example.html#x1667">dirview/dirview.cpp</a> and <a href="fileiconview-example.html#x813">fileiconview/tqfileiconview.cpp</a>. <h3 class=fn>bool <a name="isRelative"></a>TQDir::isRelative () const<tt> [virtual]</tt> </h3> -Returns TRUE if the directory path is relative to the current -directory and returns FALSE if the path is absolute (e.g. under +Returns true if the directory path is relative to the current +directory and returns false if the path is absolute (e.g. under UNIX a path is relative if it does not start with a "/"). <p> <p>See also <a href="#convertToAbs">convertToAbs</a>(). <h3 class=fn>bool <a name="isRelativePath"></a>TQDir::isRelativePath ( const <a href="tqstring.html">TQString</a> & path )<tt> [static]</tt> </h3> -Returns TRUE if <em>path</em> is relative; returns FALSE if it is +Returns true if <em>path</em> is relative; returns false if it is absolute. <p> <p>See also <a href="#isRelative">isRelative</a>(). <h3 class=fn>bool <a name="isRoot"></a>TQDir::isRoot () const<tt> [virtual]</tt> </h3> -Returns TRUE if the directory is the root directory; otherwise -returns FALSE. +Returns true if the directory is the root directory; otherwise +returns false. <p> Note: If the directory is a symbolic link to the root directory -this function returns FALSE. If you want to test for this use +this function returns false. If you want to test for this use <a href="#canonicalPath">canonicalPath</a>(), e.g. <pre> TQDir d( "/tmp/root_link" ); @@ -590,8 +590,8 @@ this function returns FALSE. If you want to test for this use <h3 class=fn>bool <a name="match"></a>TQDir::match ( const <a href="tqstring.html">TQString</a> & filter, const <a href="tqstring.html">TQString</a> & fileName )<tt> [static]</tt> </h3> -Returns TRUE if the <em>fileName</em> matches the wildcard (glob) -pattern <em>filter</em>; otherwise returns FALSE. The <em>filter</em> may +Returns true if the <em>fileName</em> matches the wildcard (glob) +pattern <em>filter</em>; otherwise returns false. The <em>filter</em> may contain multiple patterns separated by spaces or semicolons. <p> (See <a href="tqregexp.html#wildcard-matching">TQRegExp wildcard matching.</a>) @@ -600,8 +600,8 @@ contain multiple patterns separated by spaces or semicolons. <h3 class=fn>bool <a name="match-2"></a>TQDir::match ( const <a href="tqstringlist.html">TQStringList</a> & filters, const <a href="tqstring.html">TQString</a> & fileName )<tt> [static]</tt> </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -<p> Returns TRUE if the <em>fileName</em> matches any of the wildcard (glob) -patterns in the list of <em>filters</em>; otherwise returns FALSE. +<p> Returns true if the <em>fileName</em> matches any of the wildcard (glob) +patterns in the list of <em>filters</em>; otherwise returns false. <p> (See <a href="tqregexp.html#wildcard-matching">TQRegExp wildcard matching.</a>) <p>See also <a href="tqregexp.html#match">TQRegExp::match</a>(). @@ -612,14 +612,14 @@ patterns in the list of <em>filters</em>; otherwise returns FALSE. <p> Returns the value set by <a href="#setMatchAllDirs">setMatchAllDirs</a>() <p> <p>See also <a href="#setMatchAllDirs">setMatchAllDirs</a>(). -<h3 class=fn>bool <a name="mkdir"></a>TQDir::mkdir ( const <a href="tqstring.html">TQString</a> & dirName, bool acceptAbsPath = TRUE ) const<tt> [virtual]</tt> +<h3 class=fn>bool <a name="mkdir"></a>TQDir::mkdir ( const <a href="tqstring.html">TQString</a> & dirName, bool acceptAbsPath = true ) const<tt> [virtual]</tt> </h3> Creates a directory. -<p> If <em>acceptAbsPath</em> is TRUE a path starting with a separator ('/') -will create the absolute directory; if <em>acceptAbsPath</em> is FALSE +<p> If <em>acceptAbsPath</em> is true a path starting with a separator ('/') +will create the absolute directory; if <em>acceptAbsPath</em> is false any number of separators at the beginning of <em>dirName</em> will be removed. -<p> Returns TRUE if successful; otherwise returns FALSE. +<p> Returns true if successful; otherwise returns false. <p> <p>See also <a href="#rmdir">rmdir</a>(). <h3 class=fn><a href="tqstring.html">TQString</a> <a name="nameFilter"></a>TQDir::nameFilter () const @@ -630,9 +630,9 @@ removed. <h3 class=fn>bool <a name="operator!-eq"></a>TQDir::operator!= ( const <a href="tqdir.html">TQDir</a> & d ) const<tt> [virtual]</tt> </h3> -<p> Returns TRUE if directory <em>d</em> and this directory have different +<p> Returns true if directory <em>d</em> and this directory have different paths or different sort or filter settings; otherwise returns -FALSE. +false. <p> Example: <pre> // The current directory is "/usr/local" @@ -654,9 +654,9 @@ This is an overloaded member function, provided for convenience. It behaves esse <h3 class=fn>bool <a name="operator-eq-eq"></a>TQDir::operator== ( const <a href="tqdir.html">TQDir</a> & d ) const<tt> [virtual]</tt> </h3> -Returns TRUE if directory <em>d</em> and this directory have the same +Returns true if directory <em>d</em> and this directory have the same path and their sort and filter settings are the same; otherwise -returns FALSE. +returns false. <p> Example: <pre> // The current directory is "/usr/local" @@ -689,23 +689,23 @@ contains redundant ".", ".." or multiple separators. </h3> Refreshes the directory information. -<h3 class=fn>bool <a name="remove"></a>TQDir::remove ( const <a href="tqstring.html">TQString</a> & fileName, bool acceptAbsPath = TRUE )<tt> [virtual]</tt> +<h3 class=fn>bool <a name="remove"></a>TQDir::remove ( const <a href="tqstring.html">TQString</a> & fileName, bool acceptAbsPath = true )<tt> [virtual]</tt> </h3> Removes the file, <em>fileName</em>. -<p> If <em>acceptAbsPath</em> is TRUE a path starting with separator "/" +<p> If <em>acceptAbsPath</em> is true a path starting with separator "/" will remove the file with the absolute path. If <em>acceptAbsPath</em> -is FALSE any number of separators at the beginning of <em>fileName</em> +is false any number of separators at the beginning of <em>fileName</em> will be removed and the resultant file name will be removed. -<p> Returns TRUE if the file is removed successfully; otherwise -returns FALSE. +<p> Returns true if the file is removed successfully; otherwise +returns false. -<h3 class=fn>bool <a name="rename"></a>TQDir::rename ( const <a href="tqstring.html">TQString</a> & oldName, const <a href="tqstring.html">TQString</a> & newName, bool acceptAbsPaths = TRUE )<tt> [virtual]</tt> +<h3 class=fn>bool <a name="rename"></a>TQDir::rename ( const <a href="tqstring.html">TQString</a> & oldName, const <a href="tqstring.html">TQString</a> & newName, bool acceptAbsPaths = true )<tt> [virtual]</tt> </h3> Renames a file or directory. -<p> If <em>acceptAbsPaths</em> is TRUE a path starting with a separator -('/') will rename the file with the absolute path; if <em>acceptAbsPaths</em> is FALSE any number of separators at the beginning +<p> If <em>acceptAbsPaths</em> is true a path starting with a separator +('/') will rename the file with the absolute path; if <em>acceptAbsPaths</em> is false any number of separators at the beginning of the names will be removed. -<p> Returns TRUE if successful; otherwise returns FALSE. +<p> Returns true if successful; otherwise returns false. <p> On most file systems, <a href="#rename">rename</a>() fails only if <em>oldName</em> does not exist or if <em>newName</em> and <em>oldName</em> are not on the same partition. On Windows, rename() will fail if <em>newName</em> already @@ -714,15 +714,15 @@ fail. For example, on at least one file system rename() fails if <em>newName</em> points to an open file. <p>Example: <a href="fileiconview-example.html#x814">fileiconview/tqfileiconview.cpp</a>. -<h3 class=fn>bool <a name="rmdir"></a>TQDir::rmdir ( const <a href="tqstring.html">TQString</a> & dirName, bool acceptAbsPath = TRUE ) const<tt> [virtual]</tt> +<h3 class=fn>bool <a name="rmdir"></a>TQDir::rmdir ( const <a href="tqstring.html">TQString</a> & dirName, bool acceptAbsPath = true ) const<tt> [virtual]</tt> </h3> Removes a directory. -<p> If <em>acceptAbsPath</em> is TRUE a path starting with a separator ('/') -will remove the absolute directory; if <em>acceptAbsPath</em> is FALSE +<p> If <em>acceptAbsPath</em> is true a path starting with a separator ('/') +will remove the absolute directory; if <em>acceptAbsPath</em> is false any number of separators at the beginning of <em>dirName</em> will be removed. <p> The directory must be empty for <a href="#rmdir">rmdir</a>() to succeed. -<p> Returns TRUE if successful; otherwise returns FALSE. +<p> Returns true if successful; otherwise returns false. <p> <p>See also <a href="#mkdir">mkdir</a>(). <h3 class=fn><a href="tqdir.html">TQDir</a> <a name="root"></a>TQDir::root ()<tt> [static]</tt> @@ -748,8 +748,8 @@ underlying operating system. <h3 class=fn>bool <a name="setCurrent"></a>TQDir::setCurrent ( const <a href="tqstring.html">TQString</a> & path )<tt> [static]</tt> </h3> Sets the application's current working directory to <em>path</em>. -Returns TRUE if the directory was successfully changed; otherwise -returns FALSE. +Returns true if the directory was successfully changed; otherwise +returns false. <h3 class=fn>void <a name="setFilter"></a>TQDir::setFilter ( int filterSpec )<tt> [virtual]</tt> </h3> @@ -760,9 +760,9 @@ should be returned by entryList() and entryInfoList(). See <h3 class=fn>void <a name="setMatchAllDirs"></a>TQDir::setMatchAllDirs ( bool enable )<tt> [virtual]</tt> </h3> -If <em>enable</em> is TRUE then all directories are included (e.g. in +If <em>enable</em> is true then all directories are included (e.g. in <a href="#entryList">entryList</a>()), and the <a href="#nameFilter">nameFilter</a>() is only applied to the files. -If <em>enable</em> is FALSE then the nameFilter() is applied to both +If <em>enable</em> is false then the nameFilter() is applied to both directories and files. <p> <p>See also <a href="#matchAllDirs">matchAllDirs</a>(). |