file chooser widget which consists of a tool button and a line edit hitting the tool button will bring up a file dialog, and the chosen file will be put in the line edit More...
#include <pqFileChooserWidget.h>
Signals | |
| void | filenamesChanged (const QStringList &) |
| Signal emitted when the filename changes. | |
| void | filenameChanged (const QString &) |
Public Member Functions | |
| pqFileChooserWidget (QWidget *p=NULL) | |
| constructor | |
| ~pqFileChooserWidget () | |
| destructor | |
| QStringList | filenames () const |
| get the filename | |
| void | setFilenames (const QStringList &) |
| set the filename | |
| QString | singleFilename () const |
| convienince functions for when using only a single file (see forceSingleFile property). | |
| void | setSingleFilename (const QString &) |
| QString | extension () |
| get the file extension for the file dialog | |
| void | setExtension (const QString &) |
| set the file extension for the file dialog | |
| bool | forceSingleFile () |
| flag specifying whether this widget should accept multiple files | |
| void | setForceSingleFile (bool flag) |
| bool | useDirectoryMode () |
| flag specifying whether this widget should use directory mode | |
| void | setUseDirectoryMode (bool flag) |
| void | setServer (pqServer *server) |
| set server to work on. | |
| pqServer * | server () |
Static Public Member Functions | |
| static QStringList | splitFilenames (const QString &filesString) |
| Converts between a list of file names and delimited string of filenames (which is shown in the line edit box). | |
| static QString | joinFilenames (const QStringList &filesList) |
Protected Slots | |
| void | chooseFile () |
| Called when the user hits the choose file button. | |
| void | handleFileLineEditChanged (const QString &fileString) |
| Respond to changes with the filename in the line edit box. | |
Protected Member Functions | |
| void | emitFilenamesChanged (const QStringList &fileList) |
| Takes a string with delimited files and emits the filenamesChanged and filenameChanged signals. | |
Protected Attributes | |
| QString | Extension |
| QLineEdit * | LineEdit |
| pqServer * | Server |
| bool | ForceSingleFile |
| bool | UseDirectoryMode |
| QStringList | FilenameList |
| bool | UseFilenameList |
Properties | |
| QStringList | filenames |
| QString | singleFilename |
| QString | extension |
| bool | useDirectoryMode |
| bool | forceSingleFile |
Detailed Description
file chooser widget which consists of a tool button and a line edit hitting the tool button will bring up a file dialog, and the chosen file will be put in the line edit
Definition at line 47 of file pqFileChooserWidget.h.
Constructor & Destructor Documentation
| pqFileChooserWidget::pqFileChooserWidget | ( | QWidget * | p = NULL | ) |
constructor
| pqFileChooserWidget::~pqFileChooserWidget | ( | ) |
destructor
Member Function Documentation
| QStringList pqFileChooserWidget::filenames | ( | ) | const |
get the filename
| void pqFileChooserWidget::setFilenames | ( | const QStringList & | ) |
set the filename
| QString pqFileChooserWidget::singleFilename | ( | ) | const |
convienince functions for when using only a single file (see forceSingleFile property).
| void pqFileChooserWidget::setSingleFilename | ( | const QString & | ) |
| QString pqFileChooserWidget::extension | ( | ) |
get the file extension for the file dialog
| void pqFileChooserWidget::setExtension | ( | const QString & | ) |
set the file extension for the file dialog
| bool pqFileChooserWidget::forceSingleFile | ( | ) | [inline] |
flag specifying whether this widget should accept multiple files
Definition at line 81 of file pqFileChooserWidget.h.
| void pqFileChooserWidget::setForceSingleFile | ( | bool | flag | ) | [inline] |
Definition at line 82 of file pqFileChooserWidget.h.
| bool pqFileChooserWidget::useDirectoryMode | ( | ) | [inline] |
flag specifying whether this widget should use directory mode
Definition at line 88 of file pqFileChooserWidget.h.
| void pqFileChooserWidget::setUseDirectoryMode | ( | bool | flag | ) | [inline] |
Definition at line 89 of file pqFileChooserWidget.h.
| void pqFileChooserWidget::setServer | ( | pqServer * | server | ) |
set server to work on.
If server is NULL, a local file dialog is used
| pqServer* pqFileChooserWidget::server | ( | ) |
| static QStringList pqFileChooserWidget::splitFilenames | ( | const QString & | filesString | ) | [inline, static] |
Converts between a list of file names and delimited string of filenames (which is shown in the line edit box).
Definition at line 101 of file pqFileChooserWidget.h.
| static QString pqFileChooserWidget::joinFilenames | ( | const QStringList & | filesList | ) | [inline, static] |
Definition at line 104 of file pqFileChooserWidget.h.
| void pqFileChooserWidget::filenamesChanged | ( | const QStringList & | ) | [signal] |
Signal emitted when the filename changes.
The single string version is a convenience for when you are only grabbing the first file anyway.
| void pqFileChooserWidget::filenameChanged | ( | const QString & | ) | [signal] |
| void pqFileChooserWidget::chooseFile | ( | ) | [protected, slot] |
Called when the user hits the choose file button.
| void pqFileChooserWidget::handleFileLineEditChanged | ( | const QString & | fileString | ) | [protected, slot] |
Respond to changes with the filename in the line edit box.
| void pqFileChooserWidget::emitFilenamesChanged | ( | const QStringList & | fileList | ) | [protected] |
Takes a string with delimited files and emits the filenamesChanged and filenameChanged signals.
Member Data Documentation
QString pqFileChooserWidget::Extension [protected] |
Definition at line 121 of file pqFileChooserWidget.h.
QLineEdit* pqFileChooserWidget::LineEdit [protected] |
Definition at line 122 of file pqFileChooserWidget.h.
pqServer* pqFileChooserWidget::Server [protected] |
Definition at line 123 of file pqFileChooserWidget.h.
bool pqFileChooserWidget::ForceSingleFile [protected] |
Definition at line 124 of file pqFileChooserWidget.h.
bool pqFileChooserWidget::UseDirectoryMode [protected] |
Definition at line 125 of file pqFileChooserWidget.h.
QStringList pqFileChooserWidget::FilenameList [protected] |
Definition at line 126 of file pqFileChooserWidget.h.
bool pqFileChooserWidget::UseFilenameList [protected] |
Definition at line 127 of file pqFileChooserWidget.h.
Property Documentation
QStringList pqFileChooserWidget::filenames [read, write] |
Definition at line 50 of file pqFileChooserWidget.h.
QString pqFileChooserWidget::singleFilename [read, write] |
Definition at line 52 of file pqFileChooserWidget.h.
QString pqFileChooserWidget::extension [read, write] |
Definition at line 53 of file pqFileChooserWidget.h.
bool pqFileChooserWidget::useDirectoryMode [read, write] |
Definition at line 55 of file pqFileChooserWidget.h.
bool pqFileChooserWidget::forceSingleFile [read, write] |
Definition at line 57 of file pqFileChooserWidget.h.
The documentation for this class was generated from the following file:
- /home/kitware/Dashboards/My Tests/ParaView/Qt/Components/pqFileChooserWidget.h
