Reference documentation for deal.II version 8.1.0
Public Member Functions | Protected Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
dealii::ParameterGui::MainWindow Class Reference

#include <mainwindow.h>

Inheritance diagram for dealii::ParameterGui::MainWindow:
[legend]

Public Member Functions

 MainWindow (const QString &filename="")
 

Protected Member Functions

void closeEvent (QCloseEvent *event)
 

Private Slots

void open ()
 
bool save ()
 
bool save_as ()
 
void about ()
 
void tree_was_modified ()
 

Private Member Functions

void show_message ()
 
void create_actions ()
 
void create_menus ()
 
bool maybe_save ()
 
bool save_file (const QString &filename)
 
void load_file (const QString &filename)
 
void set_current_file (const QString &filename)
 

Private Attributes

QTreeWidget * tree_widget
 
QMenu * file_menu
 
QMenu * help_menu
 
QAction * open_act
 
QAction * save_act
 
QAction * save_as_act
 
QAction * exit_act
 
QAction * about_act
 
QAction * about_qt_act
 
QString current_file
 
InfoMessageinfo_message
 
QSettings * gui_settings
 

Detailed Description

The MainWindow class of the the parameterGUI. The parameterGUI is a graphical user interface for editing parameter files based on the XML format, created by the ParameterHandler::print_parameters() function with ParameterHandler::XML as second argument. Please see Representation of Parameters in the documentation of the ParameterHandler class for more details. The MainWindow class provides the basic functionality of the GUI as save- and load-file-actions and documentation. The parameterGUI provides special editors for the different types of parameters defined in the ParameterHandler class.

Note
This class is used in the graphical user interface for the ParameterHandler class. It is not compiled into the deal.II libraries and can not be used by applications using deal.II.
Author
Martin Steigemann, Wolfgang Bangerth, 2010

Definition at line 50 of file mainwindow.h.

Constructor & Destructor Documentation

dealii::ParameterGui::MainWindow::MainWindow ( const QString &  filename = "")

Constructor. If a filename is given, the MainWindow tries to open and parse the file.

Member Function Documentation

void dealii::ParameterGui::MainWindow::closeEvent ( QCloseEvent *  event)
protected

Reimplemented from QMainWindow. We ask, if changes should be saved.

void dealii::ParameterGui::MainWindow::open ( )
privateslot

Open a parameter file.

bool dealii::ParameterGui::MainWindow::save ( )
privateslot

Save the parameter file.

bool dealii::ParameterGui::MainWindow::save_as ( )
privateslot

Open a file dialog to save the parameter file.

void dealii::ParameterGui::MainWindow::about ( )
privateslot

Show some information on the parameterGUI

void dealii::ParameterGui::MainWindow::tree_was_modified ( )
privateslot

A slot that should be always called, if parameter values were changed.

void dealii::ParameterGui::MainWindow::show_message ( )
private

Show an information dialog, how parameters can be edited.

void dealii::ParameterGui::MainWindow::create_actions ( )
private

This function creates all actions.

void dealii::ParameterGui::MainWindow::create_menus ( )
private

This function creates all menus.

bool dealii::ParameterGui::MainWindow::maybe_save ( )
private

This function checks, if parameters were changed and show a dialog, if changes should be saved. This function should be always called, before open a new parameter file or before closing the GUI

bool dealii::ParameterGui::MainWindow::save_file ( const QString &  filename)
private

Save parameters to filename in XML format.

void dealii::ParameterGui::MainWindow::load_file ( const QString &  filename)
private

Load parameters from filename in XML format.

void dealii::ParameterGui::MainWindow::set_current_file ( const QString &  filename)
private

This functions writes the current filename to the window title.

Member Data Documentation

QTreeWidget* dealii::ParameterGui::MainWindow::tree_widget
private

This is the tree structure in which we store all parameters.

Definition at line 131 of file mainwindow.h.

QMenu* dealii::ParameterGui::MainWindow::file_menu
private

This menu provides all file actions as open, save, save as and exit

Definition at line 136 of file mainwindow.h.

QMenu* dealii::ParameterGui::MainWindow::help_menu
private

This menu provides some informations about the parameterGUI and about Qt

Definition at line 141 of file mainwindow.h.

QAction* dealii::ParameterGui::MainWindow::open_act
private

QAction open a file.

Definition at line 145 of file mainwindow.h.

QAction* dealii::ParameterGui::MainWindow::save_act
private

QAction save a file.

Definition at line 149 of file mainwindow.h.

QAction* dealii::ParameterGui::MainWindow::save_as_act
private

QAction save as a file.

Definition at line 153 of file mainwindow.h.

QAction* dealii::ParameterGui::MainWindow::exit_act
private

QAction exit the GUI.

Definition at line 157 of file mainwindow.h.

QAction* dealii::ParameterGui::MainWindow::about_act
private

QAction about the parameterGUI.

Definition at line 161 of file mainwindow.h.

QAction* dealii::ParameterGui::MainWindow::about_qt_act
private

QAction about Qt.

Definition at line 165 of file mainwindow.h.

QString dealii::ParameterGui::MainWindow::current_file
private

This value stores the current filename we work on.

Definition at line 169 of file mainwindow.h.

InfoMessage* dealii::ParameterGui::MainWindow::info_message
private

This dialog shows a short information message after loading a file.

Definition at line 173 of file mainwindow.h.

QSettings* dealii::ParameterGui::MainWindow::gui_settings
private

An object for storing user settings.

Definition at line 177 of file mainwindow.h.


The documentation for this class was generated from the following file: