diff options
Diffstat (limited to 'doc/html/tqfileinfo.html')
| -rw-r--r-- | doc/html/tqfileinfo.html | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/html/tqfileinfo.html b/doc/html/tqfileinfo.html index 52cd5286f..a4c1ed05d 100644 --- a/doc/html/tqfileinfo.html +++ b/doc/html/tqfileinfo.html @@ -55,10 +55,10 @@ body { background: #ffffff; color: black; } <li class=fn>TQString <a href="#filePath"><b>filePath</b></a> () const</li> <li class=fn>TQString <a href="#fileName"><b>fileName</b></a> () const</li> <li class=fn>TQString <a href="#absFilePath"><b>absFilePath</b></a> () const</li> -<li class=fn>TQString <a href="#baseName"><b>baseName</b></a> ( bool complete = FALSE ) const</li> -<li class=fn>TQString <a href="#extension"><b>extension</b></a> ( bool complete = TRUE ) const</li> -<li class=fn>TQString <a href="#dirPath"><b>dirPath</b></a> ( bool absPath = FALSE ) const</li> -<li class=fn>TQDir <a href="#dir"><b>dir</b></a> ( bool absPath = FALSE ) const</li> +<li class=fn>TQString <a href="#baseName"><b>baseName</b></a> ( bool complete = false ) const</li> +<li class=fn>TQString <a href="#extension"><b>extension</b></a> ( bool complete = true ) const</li> +<li class=fn>TQString <a href="#dirPath"><b>dirPath</b></a> ( bool absPath = false ) const</li> +<li class=fn>TQDir <a href="#dir"><b>dir</b></a> ( bool absPath = false ) const</li> <li class=fn>bool <a href="#isReadable"><b>isReadable</b></a> () const</li> <li class=fn>bool <a href="#isWritable"><b>isWritable</b></a> () const</li> <li class=fn>bool <a href="#isExecutable"><b>isExecutable</b></a> () const</li> @@ -107,7 +107,7 @@ file. Because files can be changed by other users or programs, or even by other parts of the same program, there is a function that refreshes the file information: <a href="#refresh">refresh</a>(). If you want to switch off a TQFileInfo's caching and force it to access the file system -every time you request information from it call <a href="#setCaching">setCaching</a>(FALSE). +every time you request information from it call <a href="#setCaching">setCaching</a>(false). <p> The file's type is obtained with <a href="#isFile">isFile</a>(), <a href="#isDir">isDir</a>() and <a href="#isSymLink">isSymLink</a>(). The <a href="#readLink">readLink</a>() function provides the name of the file the symlink points to. @@ -195,26 +195,26 @@ directory. On Windows this will always begin 'D:/' where D is a drive letter, except for network shares that are not mapped to a drive letter, in which case the path will begin '//sharename/'. <p> This function returns the same as <a href="#filePath">filePath</a>(), unless <a href="#isRelative">isRelative</a>() -is TRUE. +is true. <p> If the TQFileInfo is empty it returns <a href="tqdir.html#currentDirPath">TQDir::currentDirPath</a>(). <p> This function can be time consuming under Unix (in the order of milliseconds). <p> <p>See also <a href="#isRelative">isRelative</a>() and <a href="#filePath">filePath</a>(). <p>Examples: <a href="biff-example.html#x1954">biff/biff.cpp</a> and <a href="fileiconview-example.html#x820">fileiconview/tqfileiconview.cpp</a>. -<h3 class=fn><a href="tqstring.html">TQString</a> <a name="baseName"></a>TQFileInfo::baseName ( bool complete = FALSE ) const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="baseName"></a>TQFileInfo::baseName ( bool complete = false ) const </h3> Returns the base name of the file. -<p> If <em>complete</em> is FALSE (the default) the base name consists of +<p> If <em>complete</em> is false (the default) the base name consists of all characters in the file name up to (but not including) the <em>first</em> '.' character. -<p> If <em>complete</em> is TRUE the base name consists of all characters in +<p> If <em>complete</em> is true the base name consists of all characters in the file up to (but not including) the <em>last</em> '.' character. <p> The path is not included in either case. <p> Example: <pre> TQFileInfo fi( "/tmp/archive.tar.gz" ); <a href="tqstring.html">TQString</a> base = fi.<a href="#baseName">baseName</a>(); // base = "archive" - base = fi.<a href="#baseName">baseName</a>( TRUE ); // base = "archive.tar" + base = fi.<a href="#baseName">baseName</a>( true ); // base = "archive.tar" </pre> <p> <p>See also <a href="#fileName">fileName</a>() and <a href="#extension">extension</a>(). @@ -222,7 +222,7 @@ the file up to (but not including) the <em>last</em> '.' character. <h3 class=fn>bool <a name="caching"></a>TQFileInfo::caching () const </h3> -<p> Returns TRUE if caching is enabled; otherwise returns FALSE. +<p> Returns true if caching is enabled; otherwise returns false. <p> <p>See also <a href="#setCaching">setCaching</a>() and <a href="#refresh">refresh</a>(). <h3 class=fn>bool <a name="convertToAbs"></a>TQFileInfo::convertToAbs () @@ -238,40 +238,40 @@ Returns the date and time when the file was created. same as <a href="#lastModified">lastModified</a>(). <p> <p>See also <a href="#lastModified">lastModified</a>() and <a href="#lastRead">lastRead</a>(). -<h3 class=fn><a href="tqdir.html">TQDir</a> <a name="dir"></a>TQFileInfo::dir ( bool absPath = FALSE ) const +<h3 class=fn><a href="tqdir.html">TQDir</a> <a name="dir"></a>TQFileInfo::dir ( bool absPath = false ) const </h3> Returns the file's path as a <a href="tqdir.html">TQDir</a> object. -<p> If the TQFileInfo is relative and <em>absPath</em> is FALSE, the TQDir +<p> If the TQFileInfo is relative and <em>absPath</em> is false, the TQDir will be relative; otherwise it will be absolute. <p> <p>See also <a href="#dirPath">dirPath</a>(), <a href="#filePath">filePath</a>(), <a href="#fileName">fileName</a>(), and <a href="#isRelative">isRelative</a>(). <p>Example: <a href="fileiconview-example.html#x821">fileiconview/tqfileiconview.cpp</a>. -<h3 class=fn><a href="tqstring.html">TQString</a> <a name="dirPath"></a>TQFileInfo::dirPath ( bool absPath = FALSE ) const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="dirPath"></a>TQFileInfo::dirPath ( bool absPath = false ) const </h3> Returns the file's path. -<p> If <em>absPath</em> is TRUE an absolute path is returned. +<p> If <em>absPath</em> is true an absolute path is returned. <p> <p>See also <a href="#dir">dir</a>(), <a href="#filePath">filePath</a>(), <a href="#fileName">fileName</a>(), and <a href="#isRelative">isRelative</a>(). <p>Example: <a href="fileiconview-example.html#x822">fileiconview/tqfileiconview.cpp</a>. <h3 class=fn>bool <a name="exists"></a>TQFileInfo::exists () const </h3> -Returns TRUE if the file exists; otherwise returns FALSE. +Returns true if the file exists; otherwise returns false. <p>Examples: <a href="biff-example.html#x1955">biff/biff.cpp</a>, <a href="distributor-example.html#x2661">distributor/distributor.ui.h</a>, and <a href="i18n-example.html#x1937">i18n/main.cpp</a>. -<h3 class=fn><a href="tqstring.html">TQString</a> <a name="extension"></a>TQFileInfo::extension ( bool complete = TRUE ) const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="extension"></a>TQFileInfo::extension ( bool complete = true ) const </h3> Returns the file's extension name. -<p> If <em>complete</em> is TRUE (the default), <a href="#extension">extension</a>() returns the +<p> If <em>complete</em> is true (the default), <a href="#extension">extension</a>() returns the string of all characters in the file name after (but not including) the first '.' character. -<p> If <em>complete</em> is FALSE, extension() returns the string of all +<p> If <em>complete</em> is false, extension() returns the string of all characters in the file name after (but not including) the last '.' character. <p> Example: <pre> TQFileInfo fi( "/tmp/archive.tar.gz" ); <a href="tqstring.html">TQString</a> ext = fi.<a href="#extension">extension</a>(); // ext = "tar.gz" - ext = fi.<a href="#extension">extension</a>( FALSE ); // ext = "gz" + ext = fi.<a href="#extension">extension</a>( false ); // ext = "gz" </pre> <p> <p>See also <a href="#fileName">fileName</a>() and <a href="#baseName">baseName</a>(). @@ -314,19 +314,19 @@ function always returns (uint) -2. <h3 class=fn>bool <a name="isDir"></a>TQFileInfo::isDir () const </h3> -Returns TRUE if this object points to a directory or to a symbolic -link to a directory; otherwise returns FALSE. +Returns true if this object points to a directory or to a symbolic +link to a directory; otherwise returns false. <p> <p>See also <a href="#isFile">isFile</a>() and <a href="#isSymLink">isSymLink</a>(). <p>Examples: <a href="dirview-example.html#x1676">dirview/dirview.cpp</a> and <a href="fileiconview-example.html#x825">fileiconview/tqfileiconview.cpp</a>. <h3 class=fn>bool <a name="isExecutable"></a>TQFileInfo::isExecutable () const </h3> -Returns TRUE if the file is executable; otherwise returns FALSE. +Returns true if the file is executable; otherwise returns false. <p> <p>See also <a href="#isReadable">isReadable</a>(), <a href="#isWritable">isWritable</a>(), and <a href="#permission">permission</a>(). <h3 class=fn>bool <a name="isFile"></a>TQFileInfo::isFile () const </h3> -Returns TRUE if this object points to a file. Returns FALSE if the +Returns true if this object points to a file. Returns false if the object points to something which isn't a file, e.g. a directory or a symlink. <p> <p>See also <a href="#isDir">isDir</a>() and <a href="#isSymLink">isSymLink</a>(). @@ -334,34 +334,34 @@ a symlink. <p>Examples: <a href="dirview-example.html#x1677">dirview/dirview.cpp</a>, <a href="distributor-example.html#x2662">distributor/distributor.ui.h</a>, <a href="fileiconview-example.html#x826">fileiconview/tqfileiconview.cpp</a>, and <a href="tqdir-example.html#x1824">tqdir/tqdir.cpp</a>. <h3 class=fn>bool <a name="isHidden"></a>TQFileInfo::isHidden () const </h3> -Returns TRUE if the file is hidden; otherwise returns FALSE. +Returns true if the file is hidden; otherwise returns false. <p> On Unix-like operating systems, including Mac OS X, a file is hidden if its name begins with ".". On Windows a file is hidden if its hidden attribute is set. <h3 class=fn>bool <a name="isReadable"></a>TQFileInfo::isReadable () const </h3> -Returns TRUE if the file is readable; otherwise returns FALSE. +Returns true if the file is readable; otherwise returns false. <p> <p>See also <a href="#isWritable">isWritable</a>(), <a href="#isExecutable">isExecutable</a>(), and <a href="#permission">permission</a>(). <p>Example: <a href="distributor-example.html#x2663">distributor/distributor.ui.h</a>. <h3 class=fn>bool <a name="isRelative"></a>TQFileInfo::isRelative () const </h3> -Returns TRUE if the file path name is relative. Returns FALSE if +Returns true if the file path name is relative. Returns false if the path is absolute (e.g. under Unix a path is absolute if it begins with a "/"). <h3 class=fn>bool <a name="isSymLink"></a>TQFileInfo::isSymLink () const </h3> -Returns TRUE if this object points to a symbolic link (or to a +Returns true if this object points to a symbolic link (or to a shortcut on Windows, or an alias on Mac OS X); otherwise returns -FALSE. +false. <p> <p>See also <a href="#isFile">isFile</a>(), <a href="#isDir">isDir</a>(), and <a href="#readLink">readLink</a>(). <p>Examples: <a href="dirview-example.html#x1678">dirview/dirview.cpp</a>, <a href="distributor-example.html#x2664">distributor/distributor.ui.h</a>, and <a href="fileiconview-example.html#x827">fileiconview/tqfileiconview.cpp</a>. <h3 class=fn>bool <a name="isWritable"></a>TQFileInfo::isWritable () const </h3> -Returns TRUE if the file is writable; otherwise returns FALSE. +Returns true if the file is writable; otherwise returns false. <p> <p>See also <a href="#isReadable">isReadable</a>(), <a href="#isExecutable">isExecutable</a>(), and <a href="#permission">permission</a>(). <p>Example: <a href="distributor-example.html#x2665">distributor/distributor.ui.h</a>. @@ -405,7 +405,7 @@ Tests for file permissions. The <em>permissionSpec</em> argument can be several flags of type <a href="#PermissionSpec-enum">PermissionSpec</a> OR-ed together to check for permission combinations. <p> On systems where files do not have permissions this function -always returns TRUE. +always returns true. <p> Example: <pre> TQFileInfo fi( "/tmp/archive.tar.gz" ); @@ -422,7 +422,7 @@ always returns TRUE. Returns the name a symlink (or shortcut on Windows) points to, or a <a href="tqstring.html#TQString-null">TQString::null</a> if the object isn't a symbolic link. <p> This name may not represent an existing file; it is only a string. -<a href="#exists">TQFileInfo::exists</a>() returns TRUE if the symlink points to an +<a href="#exists">TQFileInfo::exists</a>() returns true if the symlink points to an existing file. <p> <p>See also <a href="#exists">exists</a>(), <a href="#isSymLink">isSymLink</a>(), <a href="#isDir">isDir</a>(), and <a href="#isFile">isFile</a>(). @@ -434,7 +434,7 @@ from the file system the next time a cached property is fetched. <h3 class=fn>void <a name="setCaching"></a>TQFileInfo::setCaching ( bool enable ) </h3> -If <em>enable</em> is TRUE, enables caching of file information. If <em>enable</em> is FALSE caching is disabled. +If <em>enable</em> is true, enables caching of file information. If <em>enable</em> is false caching is disabled. <p> When caching is enabled, TQFileInfo reads the file information from the file system the first time it's needed, but generally not later. |