From: Rene Gassmoeller <rene.gassmoeller@mailbox.org>
Date: Fri, 24 Mar 2017 21:42:30 +0000 (-0600)
Subject: Add documentation panel
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dc3df634dd62564d917317c441f0b5eaa58f6cb3;p=parameter_gui.git

Add documentation panel
---

diff --git a/mainwindow.cpp b/mainwindow.cpp
index 533fa8b..5626bc8 100644
--- a/mainwindow.cpp
+++ b/mainwindow.cpp
@@ -56,16 +56,27 @@ namespace dealii
 										// AnyKeyPressed: any key is pressed over an item
 
       tree_widget->setItemDelegate(new ParameterDelegate(1));			// set the delegate for editing items
-      setCentralWidget(tree_widget);
-										// connect: if the tree changes, the window will know
+
+      setCentralWidget(tree_widget);									// connect: if the tree changes, the window will know
+
+      connect(tree_widget, SIGNAL(currentItemChanged(QTreeWidgetItem *, QTreeWidgetItem *)), this, SLOT(set_documentation_text(QTreeWidgetItem *, QTreeWidgetItem *)));         // and connect
       connect(tree_widget, SIGNAL(itemChanged(QTreeWidgetItem*, int)), this, SLOT(tree_was_modified()));
 
+      QDockWidget *documentation_widget = new QDockWidget(tr("Parameter documentation:"), this);
+      documentation_text_widget = new QTextEdit(QString (""), documentation_widget);
+      documentation_text_widget->setReadOnly(true);
+
+      documentation_widget->setAllowedAreas(Qt::AllDockWidgetAreas);
+      documentation_widget->setWidget(documentation_text_widget);
+
+      addDockWidget(Qt::BottomDockWidgetArea, documentation_widget);
+
       create_actions();								// create window actions as "Open",...
       create_menus();								// and menus
       statusBar()->showMessage(tr("Ready, start editing by double-clicking or hitting F2!"));
       setWindowTitle(tr("[*]parameterGUI"));					// set window title
 
-      resize(800, 600);								// set window height and width
+      showMaximized();
 
       if (filename.size() > 3)							// if there is a file_name, try to load the file.
         load_file(filename);							// a vliad file has the xml extension, so we require size() > 3
@@ -73,6 +84,15 @@ namespace dealii
 
 
 
+    void MainWindow::set_documentation_text(QTreeWidgetItem *selected_item,
+                                            QTreeWidgetItem *previous_item)
+    {
+      documentation_text_widget->clear();
+      documentation_text_widget->insertPlainText(selected_item->text(3));
+    }
+
+
+
     void MainWindow::open()
     {
       if (maybe_save())								// check, if the content was modified
diff --git a/mainwindow.h b/mainwindow.h
index c9c49e5..a6eecfe 100644
--- a/mainwindow.h
+++ b/mainwindow.h
@@ -91,6 +91,13 @@ namespace dealii
 				      */
         void tree_was_modified();
 
+                                     /**
+                                      * A <tt>slot</tt> that is called when the active
+                                      * item has changed. It updates the documentation
+                                      * text in the documentation panel.
+                                      */
+        void set_documentation_text(QTreeWidgetItem *selected_item,
+                                    QTreeWidgetItem *previous_item);
       private:
 				     /**
 				      * Show an information dialog, how
@@ -124,10 +131,15 @@ namespace dealii
 				      * This functions writes the current @p filename to the window title.
 				      */
         void set_current_file (const QString  &filename);
+
 				     /**
 				      * This is the tree structure in which we store all parameters.
 				      */
         QTreeWidget * tree_widget;
+                                     /**
+                                      * This is the documentation text area.
+                                      */
+        QTextEdit *documentation_text_widget;
 				     /**
 				      * This menu provides all file actions as <tt>open</tt>, <tt>save</tt>, <tt>save as</tt>
 				      * and <tt>exit</tt>