QguWindow Class Reference

This is the QguWLinput class. More...

#include <qgu_qt4.h>

Inheritance diagram for QguWindow:

DataSelectorWindow QcalcWindow QjuiWindow qplugWindow QpWindow qwuiWindow

List of all members.

Public Slots

virtual void save ()
 Method saves the content of the window to a local file. Last used save file name is used if it exists, or default.
virtual void saveWithOut ()
 Method that saves the content of the current main window without the data using the previously provided filename.
virtual void saveAs ()
 Method saves the content of the working list within a local file using the filename as provided by the user.
virtual void saveWithOutAs ()
 Method that saves the content of the current main window without the data prompting the user to enter a filename.
virtual void include ()
virtual void restore (bool replace=true)
 Method that restores the content of the current window using the file selected by the user (or from session restore).
virtual void saveSession (QString)
 Method that saves the content of this window when saving the current QSAS session.
virtual void restoreSession (QString)
 Method that restores the content of this window when restoring a session.
void bringToFront ()
 Method that brings the current main window to the foreground and activates it.

Public Member Functions

 QguWindow (QWidget *parent=0, const char *name=0)
 Constructor of the QguWindow class.
 ~QguWindow ()
 Destructor of the QguWindow class.
virtual void save (Vostream &)=0
 Pure virtual fuction to save the contents of this window (session/working list). Overridden in sub-classes.
virtual void restore (Vistream &, bool replace=true)=0
void status (const QString &str)
 Function that displays the message str within the current window message bar.
void status (const QString &str, int ms)
 Function that displays the message str within the current window message bar.
QMenuBar * menu_bar ()
 Function that displays the message str within the current window message bar for ms milli-seconds.
QStatusBar * status_bar ()
 Function that returns the status bar pointer of the current main window object.

Public Attributes

QMenuBar * _menu_bar
 Menu bar of the current main window object.
QStatusBar * msgBar
 Message bar of the current main window object (also qsas window).
QString _filename
 Filename used to save the current session or working list content.
QString SAVE_EXTENSION
 File extension used to save the current session or working list content.
bool fromSession
 Flag set to denote that this window save was initiated by a 'save session'.
int with
 Public member defining how main window is being saved (saved with/without data).
QString _saveset_filter

Static Public Attributes

static DataNamesTable_var _saved_objects = new DataNamesTable()
 Map associating item names to QD object pointers for objects being saved.
static DataNamesTable_var _restored_objects = new DataNamesTable()
 Map associating item names to QD object pointers for objects being restored.

Detailed Description

This is the QguWLinput class.

This class specialises the QMainWindow class which provies a main application window.

Main windows are most often used to provide menus, toolbars and a status bar around a large central widget.

It inherits QMainWindow which is a built-in QT3 class

Remarks:
{ This class includes Q_OBJECT which is a QT3 macro that is used in all sub-classes of QObject in order to benefit from the QT's Meta object system which are signals and slots mechanisms for inter-object communication, runtime type information and the dynamic property system }

Constructor & Destructor Documentation

QguWindow::QguWindow ( QWidget *  parent = 0,
const char *  name = 0 
)

Constructor of the QguWindow class.

Parameters:
parent of type QWidget *
name of type const char *
Exceptions:
None 
Returns:
None

QguWindow::~QguWindow (  ) 

Destructor of the QguWindow class.

Parameters:
None 
Exceptions:
None 
Returns:
None

Member Function Documentation

void QguWindow::bringToFront (  )  [slot]

Method that brings the current main window to the foreground and activates it.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWindow::include (  )  [virtual, slot]

QMenuBar * QguWindow::menu_bar (  )  [inline]

Function that displays the message str within the current window message bar for ms milli-seconds.

Parameters:
str of const QString& type
Exceptions:
None 
Returns:
None

Reimplemented in QpWindow.

void QguWindow::restore ( bool  replace = true  )  [virtual, slot]

Method that restores the content of the current window using the file selected by the user (or from session restore).

Parameters:
bool replace
Exceptions:
None 
Returns:
None

virtual void QguWindow::restore ( Vistream &  ,
bool  replace = true 
) [pure virtual]

Implemented in QcalcWindow, QjuiWindow, qplugWindow, qwuiWindow, DataSelectorWindow, and QpWindow.

void QguWindow::restoreSession ( QString  folder  )  [virtual, slot]

Method that restores the content of this window when restoring a session.

Parameters:
folder of type QString
Exceptions:
None 
Returns:
None

void QguWindow::save (  )  [virtual, slot]

Method saves the content of the window to a local file. Last used save file name is used if it exists, or default.

Parameters:
None 
Exceptions:
None 
Returns:
None

Reimplemented in QcalcWindow, QjuiWindow, qplugWindow, and DataSelectorWindow.

void QguWindow::save ( Vostream &   )  [pure virtual]

Pure virtual fuction to save the contents of this window (session/working list). Overridden in sub-classes.

Parameters:
Vostream& 
Exceptions:
None 
Returns:
None

Implemented in QcalcWindow, QjuiWindow, qplugWindow, qwuiWindow, DataSelectorWindow, and QpWindow.

void QguWindow::saveAs (  )  [virtual, slot]

Method saves the content of the working list within a local file using the filename as provided by the user.

Parameters:
None 
Exceptions:
None 
Returns:
None

Reimplemented in QcalcWindow, QjuiWindow, qplugWindow, and DataSelectorWindow.

void QguWindow::saveSession ( QString  folder  )  [virtual, slot]

Method that saves the content of this window when saving the current QSAS session.

Parameters:
folder of type QString
Exceptions:
None 
Returns:
None

Reimplemented in QcalcWindow, QjuiWindow, qplugWindow, and DataSelectorWindow.

void QguWindow::saveWithOut (  )  [virtual, slot]

Method that saves the content of the current main window without the data using the previously provided filename.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWindow::saveWithOutAs (  )  [virtual, slot]

Method that saves the content of the current main window without the data prompting the user to enter a filename.

Parameters:
None 
Exceptions:
None 
Returns:
None

void QguWindow::status ( const QString &  str,
int  ms 
)

Function that displays the message str within the current window message bar.

Parameters:
str of const QString& type
ms of int type
Exceptions:
None 
Returns:
None

void QguWindow::status ( const QString &  str  ) 

Function that displays the message str within the current window message bar.

Parameters:
str of const QString& type
Exceptions:
None 
Returns:
None

Reimplemented in QpWindow.

QStatusBar * QguWindow::status_bar (  )  [inline]

Function that returns the status bar pointer of the current main window object.

Parameters:
None 
Exceptions:
None 
Returns:
None

Member Data Documentation

QString QguWindow::_filename

Filename used to save the current session or working list content.

QMenuBar* QguWindow::_menu_bar

Menu bar of the current main window object.

Reimplemented in QpWindow.

DataNamesTable_var QguWindow::_restored_objects = new DataNamesTable() [static]

Map associating item names to QD object pointers for objects being restored.

DataNamesTable_var QguWindow::_saved_objects = new DataNamesTable() [static]

Map associating item names to QD object pointers for objects being saved.

QString QguWindow::_saveset_filter

bool QguWindow::fromSession

Flag set to denote that this window save was initiated by a 'save session'.

QStatusBar* QguWindow::msgBar

Message bar of the current main window object (also qsas window).

QString QguWindow::SAVE_EXTENSION

File extension used to save the current session or working list content.

int QguWindow::with

Public member defining how main window is being saved (saved with/without data).

The documentation for this class was generated from the following files:
Generated on Fri Jan 8 12:51:29 2010 for QSAS by  doxygen 1.5.7