diff options
Diffstat (limited to 'doc/man/man3/tqdir.3qt')
| -rw-r--r-- | doc/man/man3/tqdir.3qt | 88 |
1 files changed, 44 insertions, 44 deletions
diff --git a/doc/man/man3/tqdir.3qt b/doc/man/man3/tqdir.3qt index 1cf380043..25733d332 100644 --- a/doc/man/man3/tqdir.3qt +++ b/doc/man/man3/tqdir.3qt @@ -55,13 +55,13 @@ All the functions in this class are reentrant when TQt is built with thread supp .BI "virtual TQString \fBdirName\fR () const" .br .ti -1c -.BI "virtual TQString \fBfilePath\fR ( const TQString & fileName, bool acceptAbsPath = TRUE ) const" +.BI "virtual TQString \fBfilePath\fR ( const TQString & fileName, bool acceptAbsPath = true ) const" .br .ti -1c -.BI "virtual TQString \fBabsFilePath\fR ( const TQString & fileName, bool acceptAbsPath = TRUE ) const" +.BI "virtual TQString \fBabsFilePath\fR ( const TQString & fileName, bool acceptAbsPath = true ) const" .br .ti -1c -.BI "virtual bool \fBcd\fR ( const TQString & dirName, bool acceptAbsPath = TRUE )" +.BI "virtual bool \fBcd\fR ( const TQString & dirName, bool acceptAbsPath = true )" .br .ti -1c .BI "virtual bool \fBcdUp\fR ()" @@ -115,10 +115,10 @@ All the functions in this class are reentrant when TQt is built with thread supp .BI "virtual const TQFileInfoList * \fBentryInfoList\fR ( const TQString & nameFilter, int filterSpec = DefaultFilter, int sortSpec = DefaultSort ) const" .br .ti -1c -.BI "virtual bool \fBmkdir\fR ( const TQString & dirName, bool acceptAbsPath = TRUE ) const" +.BI "virtual bool \fBmkdir\fR ( const TQString & dirName, bool acceptAbsPath = true ) const" .br .ti -1c -.BI "virtual bool \fBrmdir\fR ( const TQString & dirName, bool acceptAbsPath = TRUE ) const" +.BI "virtual bool \fBrmdir\fR ( const TQString & dirName, bool acceptAbsPath = true ) const" .br .ti -1c .BI "virtual bool \fBisReadable\fR () const" @@ -142,13 +142,13 @@ All the functions in this class are reentrant when TQt is built with thread supp .BI "virtual bool \fBoperator!=\fR ( const TQDir & d ) const" .br .ti -1c -.BI "virtual bool \fBremove\fR ( const TQString & fileName, bool acceptAbsPath = TRUE )" +.BI "virtual bool \fBremove\fR ( const TQString & fileName, bool acceptAbsPath = true )" .br .ti -1c -.BI "virtual bool \fBrename\fR ( const TQString & oldName, const TQString & newName, bool acceptAbsPaths = TRUE )" +.BI "virtual bool \fBrename\fR ( const TQString & oldName, const TQString & newName, bool acceptAbsPaths = true )" .br .ti -1c -.BI "virtual bool \fBexists\fR ( const TQString & name, bool acceptAbsPath = TRUE )" +.BI "virtual bool \fBexists\fR ( const TQString & name, bool acceptAbsPath = true )" .br .ti -1c .BI "void \fBrefresh\fR () const" @@ -401,10 +401,10 @@ Constructs a TQDir that is a copy of the directory \fId\fR. See also operator=(). .SH "TQDir::~TQDir ()\fC [virtual]\fR" Destroys the TQDir frees up its resources. -.SH "TQString TQDir::absFilePath ( const TQString & fileName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" +.SH "TQString TQDir::absFilePath ( const TQString & fileName, bool acceptAbsPath = true ) const\fC [virtual]\fR" Returns the absolute path name of a file in the directory. Does \fInot\fR check if the file actually exists in the directory. Redundant multiple separators or "." and ".." directories in \fIfileName\fR will not be removed (see cleanDirPath()). .PP -If \fIacceptAbsPath\fR is TRUE a \fIfileName\fR starting with a separator "/" will be returned without change. If \fIacceptAbsPath\fR is FALSE an absolute path will be prepended to the fileName and the resultant string returned. +If \fIacceptAbsPath\fR is true a \fIfileName\fR starting with a separator "/" will be returned without change. If \fIacceptAbsPath\fR is false an absolute path will be prepended to the fileName and the resultant string returned. .PP See also filePath(). .SH "TQString TQDir::absPath () const\fC [virtual]\fR" @@ -419,12 +419,12 @@ Returns the canonical path, i.e. a path without symbolic links or redundant "." On systems that do not have symbolic links this function will always return the same string that absPath() returns. If the canonical path does not exist (normally due to dangling symbolic links) canonicalPath() returns TQString::null. .PP See also path(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), and TQString::isNull(). -.SH "bool TQDir::cd ( const TQString & dirName, bool acceptAbsPath = TRUE )\fC [virtual]\fR" +.SH "bool TQDir::cd ( const TQString & dirName, bool acceptAbsPath = true )\fC [virtual]\fR" Changes the TQDir's directory to \fIdirName\fR. .PP -If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will cause the function to change to the absolute directory. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed and the function will descend into \fIdirName\fR. +If \fIacceptAbsPath\fR is true a path starting with separator "/" will cause the function to change to the absolute directory. If \fIacceptAbsPath\fR is false any number of separators at the beginning of \fIdirName\fR will be removed and the function will descend into \fIdirName\fR. .PP -Returns TRUE if the new directory exists and is readable; otherwise returns FALSE. Note that the logical cd() operation is not performed if the new directory does not exist. +Returns true if the new directory exists and is readable; otherwise returns false. Note that the logical cd() operation is not performed if the new directory does not exist. .PP Calling cd( ".." ) is equivalent to calling cdUp(). .PP @@ -434,7 +434,7 @@ Example: fileiconview/mainwindow.cpp. .SH "bool TQDir::cdUp ()\fC [virtual]\fR" Changes directory by moving one directory up from the TQDir's current directory. .PP -Returns TRUE if the new directory exists and is readable; otherwise returns FALSE. Note that the logical cdUp() operation is not performed if the new directory does not exist. +Returns true if the new directory exists and is readable; otherwise returns false. Note that the logical cdUp() operation is not performed if the new directory does not exist. .PP See also cd(), isReadable(), exists(), and path(). .SH "TQString TQDir::cleanDirPath ( const TQString & filePath )\fC [static]\fR" @@ -551,24 +551,24 @@ The filter and sorting specifications can be overridden using the \fIfilterSpec\ Returns an empty list if the directory is unreadable or does not exist. .PP See also entryInfoList(), setNameFilter(), setSorting(), and setFilter(). -.SH "bool TQDir::exists ( const TQString & name, bool acceptAbsPath = TRUE )\fC [virtual]\fR" +.SH "bool TQDir::exists ( const TQString & name, bool acceptAbsPath = true )\fC [virtual]\fR" Checks for the existence of the file \fIname\fR. .PP -If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will check the file with the absolute path. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIname\fR will be removed and the resultant file name will be checked. +If \fIacceptAbsPath\fR is true a path starting with separator "/" will check the file with the absolute path. If \fIacceptAbsPath\fR is false any number of separators at the beginning of \fIname\fR will be removed and the resultant file name will be checked. .PP -Returns TRUE if the file exists; otherwise returns FALSE. +Returns true if the file exists; otherwise returns false. .PP See also TQFileInfo::exists() and TQFile::exists(). .SH "bool TQDir::exists () const\fC [virtual]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if the \fIdirectory\fR exists; otherwise returns FALSE. (If a file with the same name is found this function will return FALSE). +Returns true if the \fIdirectory\fR exists; otherwise returns false. (If a file with the same name is found this function will return false). .PP See also TQFileInfo::exists() and TQFile::exists(). -.SH "TQString TQDir::filePath ( const TQString & fileName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" +.SH "TQString TQDir::filePath ( const TQString & fileName, bool acceptAbsPath = true ) const\fC [virtual]\fR" Returns the path name of a file in the directory. Does \fInot\fR 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 \fIfileName\fR will not be removed (see cleanDirPath()). .PP -If \fIacceptAbsPath\fR is TRUE a \fIfileName\fR starting with a separator "/" will be returned without change. If \fIacceptAbsPath\fR is FALSE an absolute path will be prepended to the fileName and the resultant string returned. +If \fIacceptAbsPath\fR is true a \fIfileName\fR starting with a separator "/" will be returned without change. If \fIacceptAbsPath\fR is false an absolute path will be prepended to the fileName and the resultant string returned. .PP See also absFilePath(), isRelative(), and canonicalPath(). .SH "FilterSpec TQDir::filter () const" @@ -586,26 +586,26 @@ Returns the absolute path of the user's home directory. .PP See also home(). .SH "bool TQDir::isReadable () const\fC [virtual]\fR" -Returns TRUE if the directory is readable \fIand\fR we can open files by name; otherwise returns FALSE. +Returns true if the directory is readable \fIand\fR we can open files by name; otherwise returns false. .PP -\fBWarning:\fR A FALSE value from this function is not a guarantee that files in the directory are not accessible. +\fBWarning:\fR A false value from this function is not a guarantee that files in the directory are not accessible. .PP See also TQFileInfo::isReadable(). .PP Examples: .)l dirview/dirview.cpp and fileiconview/tqfileiconview.cpp. .SH "bool TQDir::isRelative () const\fC [virtual]\fR" -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 "/"). +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 "/"). .PP See also convertToAbs(). .SH "bool TQDir::isRelativePath ( const TQString & path )\fC [static]\fR" -Returns TRUE if \fIpath\fR is relative; returns FALSE if it is absolute. +Returns true if \fIpath\fR is relative; returns false if it is absolute. .PP See also isRelative(). .SH "bool TQDir::isRoot () const\fC [virtual]\fR" -Returns TRUE if the directory is the root directory; otherwise returns FALSE. +Returns true if the directory is the root directory; otherwise returns false. .PP -Note: If the directory is a symbolic link to the root directory this function returns FALSE. If you want to test for this use canonicalPath(), e.g. +Note: If the directory is a symbolic link to the root directory this function returns false. If you want to test for this use canonicalPath(), e.g. .PP .nf .br @@ -621,7 +621,7 @@ Note: If the directory is a symbolic link to the root directory this function re .PP See also root() and rootDirPath(). .SH "bool TQDir::match ( const TQString & filter, const TQString & fileName )\fC [static]\fR" -Returns TRUE if the \fIfileName\fR matches the wildcard (glob) pattern \fIfilter\fR; otherwise returns FALSE. The \fIfilter\fR may contain multiple patterns separated by spaces or semicolons. +Returns true if the \fIfileName\fR matches the wildcard (glob) pattern \fIfilter\fR; otherwise returns false. The \fIfilter\fR may contain multiple patterns separated by spaces or semicolons. .PP (See TQRegExp wildcard matching.) .PP @@ -629,7 +629,7 @@ See also TQRegExp::match(). .SH "bool TQDir::match ( const TQStringList & filters, const TQString & fileName )\fC [static]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -Returns TRUE if the \fIfileName\fR matches any of the wildcard (glob) patterns in the list of \fIfilters\fR; otherwise returns FALSE. +Returns true if the \fIfileName\fR matches any of the wildcard (glob) patterns in the list of \fIfilters\fR; otherwise returns false. .PP (See TQRegExp wildcard matching.) .PP @@ -638,18 +638,18 @@ See also TQRegExp::match(). Returns the value set by setMatchAllDirs() .PP See also setMatchAllDirs(). -.SH "bool TQDir::mkdir ( const TQString & dirName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" +.SH "bool TQDir::mkdir ( const TQString & dirName, bool acceptAbsPath = true ) const\fC [virtual]\fR" Creates a directory. .PP -If \fIacceptAbsPath\fR is TRUE a path starting with a separator ('/') will create the absolute directory; if \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed. +If \fIacceptAbsPath\fR is true a path starting with a separator ('/') will create the absolute directory; if \fIacceptAbsPath\fR is false any number of separators at the beginning of \fIdirName\fR will be removed. .PP -Returns TRUE if successful; otherwise returns FALSE. +Returns true if successful; otherwise returns false. .PP See also rmdir(). .SH "TQString TQDir::nameFilter () const" Returns the string set by setNameFilter() .SH "bool TQDir::operator!= ( const TQDir & d ) const\fC [virtual]\fR" -Returns TRUE if directory \fId\fR and this directory have different paths or different sort or filter settings; otherwise returns FALSE. +Returns true if directory \fId\fR and this directory have different paths or different sort or filter settings; otherwise returns false. .PP Example: .PP @@ -673,7 +673,7 @@ This is an overloaded member function, provided for convenience. It behaves esse .PP Sets the directory path to be the given \fIpath\fR. .SH "bool TQDir::operator== ( const TQDir & d ) const\fC [virtual]\fR" -Returns TRUE if directory \fId\fR and this directory have the same path and their sort and filter settings are the same; otherwise returns FALSE. +Returns true if directory \fId\fR and this directory have the same path and their sort and filter settings are the same; otherwise returns false. .PP Example: .PP @@ -706,30 +706,30 @@ The returned path can be either absolute or relative (see setPath()). See also setPath(), absPath(), exists(), cleanDirPath(), dirName(), absFilePath(), and convertSeparators(). .SH "void TQDir::refresh () const" Refreshes the directory information. -.SH "bool TQDir::remove ( const TQString & fileName, bool acceptAbsPath = TRUE )\fC [virtual]\fR" +.SH "bool TQDir::remove ( const TQString & fileName, bool acceptAbsPath = true )\fC [virtual]\fR" Removes the file, \fIfileName\fR. .PP -If \fIacceptAbsPath\fR is TRUE a path starting with separator "/" will remove the file with the absolute path. If \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIfileName\fR will be removed and the resultant file name will be removed. +If \fIacceptAbsPath\fR is true a path starting with separator "/" will remove the file with the absolute path. If \fIacceptAbsPath\fR is false any number of separators at the beginning of \fIfileName\fR will be removed and the resultant file name will be removed. .PP -Returns TRUE if the file is removed successfully; otherwise returns FALSE. -.SH "bool TQDir::rename ( const TQString & oldName, const TQString & newName, bool acceptAbsPaths = TRUE )\fC [virtual]\fR" +Returns true if the file is removed successfully; otherwise returns false. +.SH "bool TQDir::rename ( const TQString & oldName, const TQString & newName, bool acceptAbsPaths = true )\fC [virtual]\fR" Renames a file or directory. .PP -If \fIacceptAbsPaths\fR is TRUE a path starting with a separator ('/') will rename the file with the absolute path; if \fIacceptAbsPaths\fR is FALSE any number of separators at the beginning of the names will be removed. +If \fIacceptAbsPaths\fR is true a path starting with a separator ('/') will rename the file with the absolute path; if \fIacceptAbsPaths\fR is false any number of separators at the beginning of the names will be removed. .PP -Returns TRUE if successful; otherwise returns FALSE. +Returns true if successful; otherwise returns false. .PP On most file systems, rename() fails only if \fIoldName\fR does not exist or if \fInewName\fR and \fIoldName\fR are not on the same partition. On Windows, rename() will fail if \fInewName\fR already exists. However, there are also other reasons why rename() can fail. For example, on at least one file system rename() fails if \fInewName\fR points to an open file. .PP Example: fileiconview/tqfileiconview.cpp. -.SH "bool TQDir::rmdir ( const TQString & dirName, bool acceptAbsPath = TRUE ) const\fC [virtual]\fR" +.SH "bool TQDir::rmdir ( const TQString & dirName, bool acceptAbsPath = true ) const\fC [virtual]\fR" Removes a directory. .PP -If \fIacceptAbsPath\fR is TRUE a path starting with a separator ('/') will remove the absolute directory; if \fIacceptAbsPath\fR is FALSE any number of separators at the beginning of \fIdirName\fR will be removed. +If \fIacceptAbsPath\fR is true a path starting with a separator ('/') will remove the absolute directory; if \fIacceptAbsPath\fR is false any number of separators at the beginning of \fIdirName\fR will be removed. .PP The directory must be empty for rmdir() to succeed. .PP -Returns TRUE if successful; otherwise returns FALSE. +Returns true if successful; otherwise returns false. .PP See also mkdir(). .SH "TQDir TQDir::root ()\fC [static]\fR" @@ -747,13 +747,13 @@ Returns the native directory separator; "/" under UNIX (including Mac OS X) and .PP You do not need to use this function to build file paths. If you always use "/", TQt will translate your paths to conform to the underlying operating system. .SH "bool TQDir::setCurrent ( const TQString & path )\fC [static]\fR" -Sets the application's current working directory to \fIpath\fR. Returns TRUE if the directory was successfully changed; otherwise returns FALSE. +Sets the application's current working directory to \fIpath\fR. Returns true if the directory was successfully changed; otherwise returns false. .SH "void TQDir::setFilter ( int filterSpec )\fC [virtual]\fR" Sets the filter used by entryList() and entryInfoList() to \fIfilterSpec\fR. The filter is used to specify the kind of files that should be returned by entryList() and entryInfoList(). See TQDir::FilterSpec. .PP See also filter() and setNameFilter(). .SH "void TQDir::setMatchAllDirs ( bool enable )\fC [virtual]\fR" -If \fIenable\fR is TRUE then all directories are included (e.g. in entryList()), and the nameFilter() is only applied to the files. If \fIenable\fR is FALSE then the nameFilter() is applied to both directories and files. +If \fIenable\fR is true then all directories are included (e.g. in entryList()), and the nameFilter() is only applied to the files. If \fIenable\fR is false then the nameFilter() is applied to both directories and files. .PP See also matchAllDirs(). .SH "void TQDir::setNameFilter ( const TQString & nameFilter )\fC [virtual]\fR" |