Add open file dialog and print help message actions

Closes #315

Libs/Widgets/Testing/Cpp/CMakeLists.txt

@@ -20,6 +20,7 @@ set(TEST_SOURCES
   ctkColorPickerButtonTest1.cpp
   ctkComboBoxTest1.cpp
   ctkCompleterTest1.cpp
+  ctkConsoleTest.cpp
   ctkConsoleTest1.cpp
   ctkCoordinatesWidgetTest.cpp
   ctkCoordinatesWidgetTest1.cpp
@@ -176,6 +177,7 @@ endif()
 set(Tests_MOC_CPP)
 QT4_WRAP_CPP(Tests_MOC_CPP ${Tests_MOC_SRCS})
 QT4_GENERATE_MOCS(
+  ctkConsoleTest.cpp
   ctkCoordinatesWidgetTest.cpp
   ctkFlatProxyModelTest.cpp
   ctkFontButtonTest.cpp
@@ -219,6 +221,7 @@ SIMPLE_TEST( ctkColorDialogTest2 )
 SIMPLE_TEST( ctkColorPickerButtonTest1 )
 SIMPLE_TEST( ctkComboBoxTest1 )
 SIMPLE_TEST( ctkCompleterTest1 )
+SIMPLE_TEST( ctkConsoleTest )
 SIMPLE_TEST( ctkConsoleTest1 )
 SIMPLE_TEST( ctkCoordinatesWidgetTest )
 SIMPLE_TEST( ctkCoordinatesWidgetTest1 )

Libs/Widgets/Testing/Cpp/ctkConsoleTest.cpp

@@ -0,0 +1,72 @@
+/*=========================================================================
+
+  Library:   CTK
+
+  Copyright (c) Kitware Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0.txt
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+=========================================================================*/
+
+// Qt includes
+#include <QApplication>
+#include <QString>
+#include <QTimer>
+
+// CTK includes
+#include "ctkConfig.h"
+#include "ctkConsole.h"
+#include "ctkTest.h"
+
+// ----------------------------------------------------------------------------
+class ctkConsoleTester: public QObject
+{
+  Q_OBJECT
+private slots:
+  void testShow();
+
+  void testRunFile();
+  void testRunFile_data();
+};
+
+// ----------------------------------------------------------------------------
+void ctkConsoleTester::testShow()
+{
+  ctkConsole console;
+  console.show();
+  QTest::qWaitForWindowShown(&console);
+}
+
+// ----------------------------------------------------------------------------
+void ctkConsoleTester::testRunFile()
+{
+  ctkConsole console;
+  QFETCH(QString, file);
+  console.runFile(file);
+}
+
+// ----------------------------------------------------------------------------
+void ctkConsoleTester::testRunFile_data()
+{
+  QTest::addColumn<QString>("file");
+  QTest::newRow("null") << QString();
+  QTest::newRow("empty") << "";
+  QTest::newRow("invalid") << " ";
+  QTest::newRow(".") << ".";
+  QTest::newRow("file")
+    << QFileInfo(QDir(CTK_SOURCE_DIR), "README").absoluteFilePath();
+}
+
+// ----------------------------------------------------------------------------
+CTK_TEST_MAIN(ctkConsoleTest)
+#include "moc_ctkConsoleTest.cpp"

Libs/Widgets/ctkConsole.cpp

@@ -50,10 +50,13 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 // Qt includes
 #include <QAbstractItemView>
+#include <QAction>
 #include <QApplication>
 #include <QClipboard>
 #include <QCompleter>
 #include <QKeyEvent>
+#include <QFile>
+#include <QFileDialog>
 #include <QPointer>
 #include <QTextCursor>
 #include <QVBoxLayout>
@@ -124,6 +127,16 @@ void ctkConsolePrivate::init()
   this->CommandHistory.append("");
   this->CommandPosition = 0;
 
+  QAction* runFileAction = new QAction(q->tr("&Run file"),q);
+  runFileAction->setShortcut(q->tr("Ctrl+r"));
+  connect(runFileAction, SIGNAL(triggered()), q, SLOT(runFile()));
+  q->addAction(runFileAction);
+
+  QAction* printHelpAction = new QAction(q->tr("Print &help"),q);
+  printHelpAction->setShortcut(q->tr("Ctrl+h"));
+  connect(printHelpAction, SIGNAL(triggered()), q, SLOT(printHelp()));
+  q->addAction(printHelpAction);
+
   QVBoxLayout * layout = new QVBoxLayout(q);
   layout->setMargin(0);
   layout->addWidget(this);
@@ -798,6 +811,41 @@ void ctkConsole::exec(const QString& command)
 }
 
 //-----------------------------------------------------------------------------
+void ctkConsole::runFile(const QString& filePath)
+{
+  QFile file(filePath);
+  if (!file.open(QIODevice::ReadOnly))
+    {
+    qWarning() << tr( "File '%1' can't be read.").arg(filePath);
+    return;
+    }
+  for (QTextStream fileStream(&file);!fileStream.atEnd();)
+    {
+    QString line = fileStream.readLine();
+    this->exec(line);
+    }
+}
+
+//-----------------------------------------------------------------------------
+void ctkConsole::runFile()
+{
+  QString filePath =
+    QFileDialog::getOpenFileName(this, tr("Select a script file to run"));
+  if (!filePath.isEmpty())
+    {
+    this->runFile(filePath);
+    }
+}
+
+//-----------------------------------------------------------------------------
+void ctkConsole::printHelp()
+{
+  this->printMessage("\n", Qt::gray);
+  this->printMessage(tr("CTRL+h: Print this help message\n"), Qt::gray);
+  this->printMessage(tr("CTRL+r: Oepn a file dialog to select a file to run\n"), Qt::gray);
+}
+
+//-----------------------------------------------------------------------------
 void ctkConsole::executeCommand(const QString& command)
 {
   qWarning() << "ctkConsole::executeCommand not implemented !";

Libs/Widgets/ctkConsole.h

@@ -190,8 +190,21 @@ public Q_SLOTS:
   virtual void reset();
 
   /// Exec the contents of the last console line
+  /// \sa openFile(), runFile(QString)
   virtual void exec(const QString&);
 
+  /// Exec line by line the content of a file.
+  /// \sa openFile(), exec()
+  virtual void runFile(const QString& filePath);
+
+  /// Open a file dialog to select a file and run it.
+  /// Shortcut: CTRL+O
+  /// \sa runFile(QString), exec()
+  virtual void runFile();
+
+  /// Print the console help with shortcuts.
+  virtual void printHelp();
+
 protected:
 
   /// Prompt the user for input