diff options
Diffstat (limited to 'doc/man/man3/tqfiledialog.3qt')
| -rw-r--r-- | doc/man/man3/tqfiledialog.3qt | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/doc/man/man3/tqfiledialog.3qt b/doc/man/man3/tqfiledialog.3qt index 1ea10a2db..104c3bae7 100644 --- a/doc/man/man3/tqfiledialog.3qt +++ b/doc/man/man3/tqfiledialog.3qt @@ -16,10 +16,10 @@ Inherits TQDialog. .SS "Public Members" .in +1c .ti -1c -.BI "\fBTQFileDialog\fR ( const TQString & dirName, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, bool modal = FALSE )" +.BI "\fBTQFileDialog\fR ( const TQString & dirName, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, bool modal = false )" .br .ti -1c -.BI "\fBTQFileDialog\fR ( TQWidget * parent = 0, const char * name = 0, bool modal = FALSE )" +.BI "\fBTQFileDialog\fR ( TQWidget * parent = 0, const char * name = 0, bool modal = false )" .br .ti -1c .BI "\fB~TQFileDialog\fR ()" @@ -160,16 +160,16 @@ Inherits TQDialog. .SS "Static Public Members" .in +1c .ti -1c -.BI "TQString \fBgetOpenFileName\fR ( const TQString & startWith = TQString::null, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = TRUE )" +.BI "TQString \fBgetOpenFileName\fR ( const TQString & startWith = TQString::null, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = true )" .br .ti -1c -.BI "TQString \fBgetSaveFileName\fR ( const TQString & startWith = TQString::null, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = TRUE )" +.BI "TQString \fBgetSaveFileName\fR ( const TQString & startWith = TQString::null, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = true )" .br .ti -1c -.BI "TQString \fBgetExistingDirectory\fR ( const TQString & dir = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, bool dirOnly = TRUE, bool resolveSymlinks = TRUE )" +.BI "TQString \fBgetExistingDirectory\fR ( const TQString & dir = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, bool dirOnly = true, bool resolveSymlinks = true )" .br .ti -1c -.BI "TQStringList \fBgetOpenFileNames\fR ( const TQString & filter = TQString::null, const TQString & dir = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = TRUE )" +.BI "TQStringList \fBgetOpenFileNames\fR ( const TQString & filter = TQString::null, const TQString & dir = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = true )" .br .ti -1c .BI "void \fBsetIconProvider\fR ( TQFileIconProvider * provider )" @@ -217,7 +217,7 @@ Inherits TQDialog. .BI "void \fBaddWidgets\fR ( TQLabel * l, TQWidget * w, TQPushButton * b )" .br .ti -1c -.BI "void \fBaddToolButton\fR ( TQButton * b, bool separator = FALSE )" +.BI "void \fBaddToolButton\fR ( TQButton * b, bool separator = false )" .br .ti -1c .BI "void \fBaddLeftWidget\fR ( TQWidget * w )" @@ -261,7 +261,7 @@ You can create your own TQFileDialog without using the static functions. By call .PP .nf .br - TQFileDialog* fd = new TQFileDialog( this, "file dialog", TRUE ); + TQFileDialog* fd = new TQFileDialog( this, "file dialog", true ); .br fd->setMode( TQFileDialog::AnyFile ); .br @@ -353,7 +353,7 @@ Inside the class we reimplement TQFilePreview::previewUrl(), this is where we de .br TQFileDialog* fd = new TQFileDialog( this ); .br - fd->setContentsPreviewEnabled( TRUE ); + fd->setContentsPreviewEnabled( true ); .br fd->setContentsPreview( p, p ); .br @@ -363,7 +363,7 @@ Inside the class we reimplement TQFilePreview::previewUrl(), this is where we de .br .fi .PP -The first line creates an instance of our preview widget. We then create our file dialog and call setContentsPreviewEnabled( TRUE ), this tell the file dialog to preview the contents of the currently selected file. We then call setContentsPreview() -- note that we pass the same preview widget twice. Finally, before showing the file dialog, we call setPreviewMode() setting the mode to \fIContents\fR which will show the contents preview of the file that the user has selected. +The first line creates an instance of our preview widget. We then create our file dialog and call setContentsPreviewEnabled( true ), this tell the file dialog to preview the contents of the currently selected file. We then call setContentsPreview() -- note that we pass the same preview widget twice. Finally, before showing the file dialog, we call setPreviewMode() setting the mode to \fIContents\fR which will show the contents preview of the file that the user has selected. .PP If you create another preview widget that is used for displaying information about a file, create it in the same way as the contents preview widget and call setInfoPreviewEnabled(), and setInfoPreview(). Then the user will be able to switch between the two preview modes. .PP @@ -411,12 +411,12 @@ This enum describes the view mode of the file dialog, i.e. what information abou .PP See setViewMode(). .SH MEMBER FUNCTION DOCUMENTATION -.SH "TQFileDialog::TQFileDialog ( const TQString & dirName, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, bool modal = FALSE )" -Constructs a file dialog called \fIname\fR with the parent, \fIparent\fR. If \fImodal\fR is TRUE then the file dialog is modal; otherwise it is modeless. +.SH "TQFileDialog::TQFileDialog ( const TQString & dirName, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, bool modal = false )" +Constructs a file dialog called \fIname\fR with the parent, \fIparent\fR. If \fImodal\fR is true then the file dialog is modal; otherwise it is modeless. .PP If \fIdirName\fR is specified then it will be used as the dialog's working directory, i.e. it will be the directory that is shown when the dialog appears. If \fIfilter\fR is specified it will be used as the dialog's file filter. -.SH "TQFileDialog::TQFileDialog ( TQWidget * parent = 0, const char * name = 0, bool modal = FALSE )" -Constructs a file dialog called \fIname\fR, with the parent, \fIparent\fR. If \fImodal\fR is TRUE then the file dialog is modal; otherwise it is modeless. +.SH "TQFileDialog::TQFileDialog ( TQWidget * parent = 0, const char * name = 0, bool modal = false )" +Constructs a file dialog called \fIname\fR, with the parent, \fIparent\fR. If \fImodal\fR is true then the file dialog is modal; otherwise it is modeless. .SH "TQFileDialog::~TQFileDialog ()" Destroys the file dialog. .SH "void TQFileDialog::addFilter ( const TQString & filter )" @@ -443,8 +443,8 @@ See also addRightWidget(), addWidgets(), and addToolButton(). Adds the widget \fIw\fR to the right-hand side of the file dialog. .PP See also addLeftWidget(), addWidgets(), and addToolButton(). -.SH "void TQFileDialog::addToolButton ( TQButton * b, bool separator = FALSE )\fC [protected]\fR" -Adds the tool button \fIb\fR to the row of tool buttons at the top of the file dialog. The button is appended to the right of this row. If \fIseparator\fR is TRUE, a small space is inserted between the last button of the row and the new button \fIb\fR. +.SH "void TQFileDialog::addToolButton ( TQButton * b, bool separator = false )\fC [protected]\fR" +Adds the tool button \fIb\fR to the row of tool buttons at the top of the file dialog. The button is appended to the right of this row. If \fIseparator\fR is true, a small space is inserted between the last button of the row and the new button \fIb\fR. .PP See also addWidgets(), addLeftWidget(), and addRightWidget(). .SH "void TQFileDialog::addWidgets ( TQLabel * l, TQWidget * w, TQPushButton * b )\fC [protected]\fR" @@ -504,7 +504,7 @@ See also fileSelected(), fileHighlighted(), and selectedFiles. This signal is emitted when the user selects a filter. .PP See also selectedFilter. -.SH "TQString TQFileDialog::getExistingDirectory ( const TQString & dir = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, bool dirOnly = TRUE, bool resolveSymlinks = TRUE )\fC [static]\fR" +.SH "TQString TQFileDialog::getExistingDirectory ( const TQString & dir = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, bool dirOnly = true, bool resolveSymlinks = true )\fC [static]\fR" This is a convenience static function that will return an existing directory selected by the user. .PP .nf @@ -519,7 +519,7 @@ This is a convenience static function that will return an existing directory sel .br "Choose a directory", .br - TRUE ); + true ); .br .fi .PP @@ -529,14 +529,14 @@ The dialog's working directory is set to \fIdir\fR, and the caption is set to \f .PP Note on Windows that if \fIdir\fR is TQString::null then the dialog's working directory will be set to the user's My Documents directory. .PP -If \fIdirOnly\fR is TRUE, then only directories will be shown in the file dialog; otherwise both directories and files will be shown. +If \fIdirOnly\fR is true, then only directories will be shown in the file dialog; otherwise both directories and files will be shown. .PP -Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. +Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is false, the file dialog will treat symlinks as regular directories. .PP Under Windows and Mac OS X, this static function will use the native file dialog and not a TQFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any TQTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). .PP See also getOpenFileName(), getOpenFileNames(), and getSaveFileName(). -.SH "TQString TQFileDialog::getOpenFileName ( const TQString & startWith = TQString::null, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" +.SH "TQString TQFileDialog::getOpenFileName ( const TQString & startWith = TQString::null, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = true )\fC [static]\fR" This is a convenience static function that returns an existing file selected by the user. If the user pressed Cancel, it returns a null string. .PP .nf @@ -563,13 +563,13 @@ The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified .PP Under Windows and Mac OS X, this static function will use the native file dialog and not a TQFileDialog, unless the style of the application is set to something other than the native style (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any TQTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). .PP -Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. +Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is false, the file dialog will treat symlinks as regular directories. .PP See also getOpenFileNames(), getSaveFileName(), and getExistingDirectory(). .PP Examples: .)l action/application.cpp, addressbook/mainwindow.cpp, application/application.cpp, distributor/distributor.ui.h, network/ftpclient/ftpmainwindow.ui.h, qwerty/qwerty.cpp, and showimg/showimg.cpp. -.SH "TQStringList TQFileDialog::getOpenFileNames ( const TQString & filter = TQString::null, const TQString & dir = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" +.SH "TQStringList TQFileDialog::getOpenFileNames ( const TQString & filter = TQString::null, const TQString & dir = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = true )\fC [static]\fR" This is a convenience static function that will return one or more existing files selected by the user. .PP .nf @@ -596,7 +596,7 @@ The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified .PP Under Windows and Mac OS X, this static function will use the native file dialog and not a TQFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any TQTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar). .PP -Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. +Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is false, the file dialog will treat symlinks as regular directories. .PP Note that if you want to iterate over the list of files, you should iterate over a copy, e.g. .PP @@ -617,7 +617,7 @@ Note that if you want to iterate over the list of files, you should iterate over .fi .PP See also getOpenFileName(), getSaveFileName(), and getExistingDirectory(). -.SH "TQString TQFileDialog::getSaveFileName ( const TQString & startWith = TQString::null, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = TRUE )\fC [static]\fR" +.SH "TQString TQFileDialog::getSaveFileName ( const TQString & startWith = TQString::null, const TQString & filter = TQString::null, TQWidget * parent = 0, const char * name = 0, const TQString & caption = TQString::null, TQString * selectedFilter = 0, bool resolveSymlinks = true )\fC [static]\fR" This is a convenience static function that will return a file name selected by the user. The file does not have to exist. .PP It creates a modal file dialog called \fIname\fR, with parent, \fIparent\fR. If a parent is not 0, the dialog will be shown centered over the parent. @@ -644,7 +644,7 @@ The dialog's caption is set to \fIcaption\fR. If \fIcaption\fR is not specified .PP Under Windows and Mac OS X, this static function will use the native file dialog and not a TQFileDialog, unless the style of the application is set to something other than the native style. (Note that on Windows the dialog will spin a blocking modal event loop that will not dispatch any TQTimers and if parent is not 0 then it will position the dialog just under the parent's titlebar. .PP -Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is FALSE, the file dialog will treat symlinks as regular directories. +Under Unix/X11, the normal behavior of the file dialog is to resolve and follow symlinks. For example, if /usr/tmp is a symlink to /var/tmp, the file dialog will change to /var/tmp after entering /usr/tmp. If \fIresolveSymlinks\fR is false, the file dialog will treat symlinks as regular directories. .PP See also getOpenFileName(), getOpenFileNames(), and getExistingDirectory(). .PP @@ -655,9 +655,9 @@ Returns a pointer to the icon provider currently set on the file dialog. By defa .PP See also setIconProvider() and TQFileIconProvider. .SH "bool TQFileDialog::isContentsPreviewEnabled () const" -Returns TRUE if the file dialog can provide a contents preview of the currently selected file; otherwise returns FALSE. See the "contentsPreview" property for details. +Returns true if the file dialog can provide a contents preview of the currently selected file; otherwise returns false. See the "contentsPreview" property for details. .SH "bool TQFileDialog::isInfoPreviewEnabled () const" -Returns TRUE if the file dialog can provide preview information about the currently selected file; otherwise returns FALSE. See the "infoPreview" property for details. +Returns true if the file dialog can provide preview information about the currently selected file; otherwise returns false. See the "infoPreview" property for details. .SH "Mode TQFileDialog::mode () const" Returns the file dialog's mode. See the "mode" property for details. .SH "PreviewMode TQFileDialog::previewMode () const" @@ -673,7 +673,7 @@ Re-sorts the displayed directory. .PP See also rereadDir(). .SH "void TQFileDialog::selectAll ( bool b )" -If \fIb\fR is TRUE then all the files in the current directory are selected; otherwise, they are deselected. +If \fIb\fR is true then all the files in the current directory are selected; otherwise, they are deselected. .SH "TQString TQFileDialog::selectedFile () const" Returns the name of the selected file. See the "selectedFile" property for details. .SH "TQStringList TQFileDialog::selectedFiles () const" @@ -729,7 +729,7 @@ Normally you would create a preview widget that derives from both TQWidget and T .br TQFileDialog* fd = new TQFileDialog( this ); .br - fd->setContentsPreviewEnabled( TRUE ); + fd->setContentsPreviewEnabled( true ); .br fd->setContentsPreview( p, p ); .br @@ -855,7 +855,7 @@ Normally you would create a preview widget that derives from both TQWidget and T .br TQFileDialog* fd = new TQFileDialog( this ); .br - fd->setInfoPreviewEnabled( TRUE ); + fd->setInfoPreviewEnabled( true ); .br fd->setInfoPreview( p, p ); .br @@ -896,7 +896,7 @@ See also url(). .SH "void TQFileDialog::setViewMode ( ViewMode m )" Sets the file dialog's view mode to \fIm\fR. See the "viewMode" property for details. .SH "bool TQFileDialog::showHiddenFiles () const" -Returns TRUE if hidden files are shown in the file dialog; otherwise returns FALSE. See the "showHiddenFiles" property for details. +Returns true if hidden files are shown in the file dialog; otherwise returns false. See the "showHiddenFiles" property for details. .SH "TQUrl TQFileDialog::url () const" Returns the URL of the current working directory in the file dialog. .PP @@ -909,7 +909,7 @@ Returns the file dialog's view mode. See the "viewMode" property for details. .SH "bool contentsPreview" This property holds whether the file dialog can provide a contents preview of the currently selected file. .PP -The default is FALSE. +The default is false. .PP See also setContentsPreview() and infoPreview. .PP @@ -923,7 +923,7 @@ See also dir() and setDir(). .SH "bool infoPreview" This property holds whether the file dialog can provide preview information about the currently selected file. .PP -The default is FALSE. +The default is false. .PP Set this property's value with setInfoPreviewEnabled() and get this property's value with isInfoPreviewEnabled(). .SH "Mode mode" @@ -985,7 +985,7 @@ See also filterSelected(), selectedFiles, and selectedFile. .SH "bool showHiddenFiles" This property holds whether hidden files are shown in the file dialog. .PP -The default is FALSE, i.e. don't show hidden files. +The default is false, i.e. don't show hidden files. .PP Set this property's value with setShowHiddenFiles() and get this property's value with showHiddenFiles(). .SH "ViewMode viewMode" |