ParaView
pqFileChooserWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqFileChooserWidget.h
5 
6  Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 =========================================================================*/
32 
33 
34 #ifndef _pqFileChooserWidget_h
35 #define _pqFileChooserWidget_h
36 
37 #include "pqComponentsModule.h"
38 #include <QString>
39 #include <QStringList>
40 #include <QWidget>
41 class QLineEdit;
42 class pqServer;
43 
47 class PQCOMPONENTS_EXPORT pqFileChooserWidget : public QWidget
48 {
49  Q_OBJECT
50  Q_PROPERTY(QStringList filenames READ filenames WRITE setFilenames USER true)
51  Q_PROPERTY(QString singleFilename READ singleFilename WRITE
52  setSingleFilename)
53  Q_PROPERTY(QString extension READ extension WRITE setExtension)
54  Q_PROPERTY(bool useDirectoryMode
55  READ useDirectoryMode WRITE setUseDirectoryMode)
56  Q_PROPERTY(bool forceSingleFile
57  READ forceSingleFile WRITE setForceSingleFile)
58  Q_PROPERTY(bool acceptAnyFile
59  READ acceptAnyFile WRITE setAcceptAnyFile)
60 
61 public:
63  pqFileChooserWidget(QWidget* p = NULL);
66 
68  QStringList filenames() const;
70  // this doesn't verify that any of the filenames being passed
71  // in are valid for the mode or actually exist on the server. That
72  // must be down be what ever calls this method
73  void setFilenames(const QStringList&);
74 
77  QString singleFilename() const;
78  void setSingleFilename(const QString &);
79 
81  QString extension();
83  void setExtension(const QString&);
84 
86  bool forceSingleFile() { return this->ForceSingleFile; }
87  void setForceSingleFile(bool flag) {
88  this->ForceSingleFile = flag;
89  this->setFilenames(this->filenames());
90  }
91 
93  bool useDirectoryMode() { return this->UseDirectoryMode; }
94  void setUseDirectoryMode(bool flag) {
95  this->UseDirectoryMode = flag;
96  this->setFilenames(this->filenames());
97  }
98 
100  bool acceptAnyFile() { return this->AcceptAnyFile; }
101  void setAcceptAnyFile(bool flag) {
102  this->AcceptAnyFile = flag;
103  this->setFilenames(this->filenames());
104  }
105 
108  void setServer(pqServer* server);
109  pqServer* server();
110 
113  static QStringList splitFilenames(const QString &filesString) {
114  return filesString.split(";", QString::SkipEmptyParts);
115  }
116  static QString joinFilenames(const QStringList &filesList) {
117  return filesList.join(";");
118  }
119 
120 signals:
123  void filenamesChanged(const QStringList&);
124  void filenameChanged(const QString&);
125 
126 protected slots:
128  void chooseFile();
130  void handleFileLineEditChanged(const QString &fileString);
131 
132 protected:
133  QString Extension;
134  QLineEdit* LineEdit;
139  QStringList FilenameList;
141 
144  void emitFilenamesChanged(const QStringList &fileList);
145 };
146 
147 #endif // _pqFileChooserWidget_h
148 
static QString joinFilenames(const QStringList &filesList)
void setForceSingleFile(bool flag)
bool useDirectoryMode()
flag specifying whether this widget should use directory mode
static QStringList splitFilenames(const QString &filesString)
Converts between a list of file names and delimited string of filenames (which is shown in the line e...
void setUseDirectoryMode(bool flag)
void setAcceptAnyFile(bool flag)
bool acceptAnyFile()
flag specifying whether this widget should accept any file
file chooser widget which consists of a tool button and a line edit hitting the tool button will brin...
pqServer (should be renamed to pqSession) is a pqServerManagerModelItem subclass that represents a vt...
Definition: pqServer.h:62