LibEngsas
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Private Attributes | List of all members
EObject Class Reference

Mostly the same as EWidget but for QObject as base class. More...

#include <eobject.h>

+ Inheritance diagram for EObject:
+ Collaboration diagram for EObject:

Public Slots

virtual void reloadSettings ()
 Used to reload the settings. More...
 

Signals

void error (const QString &message)
 
void warning (const QString &message)
 
void information (const QString &message)
 
void reloadEnableActions ()
 Request reloading of enabled actions in EMainWindow. More...
 
void addMenu (QMenu *newMenu, const QString &parent, QString before=QString())
 
void addAction (QAction *newAction, const QString &parent, QString before=QString())
 
void addToolBar (QToolBar *newToolBar, Qt::ToolBarArea area=Qt::TopToolBarArea)
 
void addNewDockWidget (QDockWidget *widget, const Qt::DockWidgetArea &area)
 
void setCentralWidget (QWidget *centralWidget)
 
void showSettings ()
 
void showHelp (const QString &page)
 
void showStatusWidget (QWidget *widget)
 
void reloadSettingsRequest ()
 Indicates, that a reload of the settings is needed. More...
 
void doReloadSettings ()
 Emitted to bring the reload request back to the farest child. More...
 

Public Member Functions

 EObject (QObject *parent=0)
 
virtual ~EObject ()
 
void connectByPass (QObject *object)
 

Static Public Member Functions

static void connectByPass (QObject *parent, QObject *child)
 

Protected Slots

virtual void errorByPass (const QString &message)
 
virtual void warningByPass (const QString &message)
 
virtual void informationByPass (const QString &message)
 
virtual void reloadEnableActionsByPass ()
 
virtual void addMenuByPass (QMenu *newMenu, const QString &parent, QString before=QString())
 
virtual void addActionByPass (QAction *newAction, const QString &parent, QString before=QString())
 
virtual void addToolBarByPass (QToolBar *newToolBar, Qt::ToolBarArea area=Qt::TopToolBarArea)
 
virtual void addNewDockWidgetByPass (QDockWidget *widget, const Qt::DockWidgetArea &area)
 
virtual void setCentralWidgetByPass (QWidget *centralWidget)
 
virtual void showSettingsByPass ()
 
virtual void showHelpByPass (const QString &page)
 
virtual void showStatusWidgetByPass (QWidget *widget)
 
virtual void reloadSettingsRequestByPass ()
 

Protected Member Functions

void addManagedDockWidget (QDockWidget *widget, const Qt::DockWidgetArea &area, QString actionLabel=QString(), QString actionParent=QString())
 Adds an dock widget via addNewDockWidget() and adds widget to the list of managed dock widgets. More...
 

Private Attributes

QList< QPointer< QDockWidget > > dockWidgets
 
QList< QPointer< QAction > > dockActions
 

Detailed Description

Mostly the same as EWidget but for QObject as base class.

See also
Ewidget
EDialog

Constructor & Destructor Documentation

EObject::EObject ( QObject *  parent = 0)
inline
EObject::~EObject ( )
virtual

Member Function Documentation

void EObject::addAction ( QAction *  newAction,
const QString &  parent,
QString  before = QString() 
)
signal

Adds the action newAction to the main window. It is added to an existing menu with QObject::objectName() parent before the action or menu with object name before. If before is empty, it is appended at the bottom.

See also
addMenu()
addToolBar()
addActionByPass()
EWidget::addAction()
EDialog::addAction()

+ Here is the caller graph for this function:

virtual void EObject::addActionByPass ( QAction *  newAction,
const QString &  parent,
QString  before = QString() 
)
inlineprotectedvirtualslot
See also
addAction() passes the emitted signals from it's child forward
EWidget::addActionByPass()
EDialog::addActionByPass()

+ Here is the caller graph for this function:

void EObject::addManagedDockWidget ( QDockWidget *  widget,
const Qt::DockWidgetArea &  area,
QString  actionLabel = QString(),
QString  actionParent = QString() 
)
protected

Adds an dock widget via addNewDockWidget() and adds widget to the list of managed dock widgets.

If actionLabel (and also actionParent) is set, an EAction is created and added to parent actionParent to show and hide the dock widget. This action is also managed and therefore deleted along with the dock widget itself.

The benefit is, that all the dock widgets on this list are deleted automatically, if the widget it self is deleted.

+ Here is the caller graph for this function:

void EObject::addMenu ( QMenu *  newMenu,
const QString &  parent,
QString  before = QString() 
)
signal

Allows to add menu newMenu to the main window. It is added to an existing menu with QObject::objectName() parent before the action or menu with object name before. If before is empty, it is appended at the bottom.

See also
addAction() to add an action
addToolBar()
addMenuByPass()
EWidget::addMenu()
EDialog::addMenu()

+ Here is the caller graph for this function:

virtual void EObject::addMenuByPass ( QMenu *  newMenu,
const QString &  parent,
QString  before = QString() 
)
inlineprotectedvirtualslot
See also
addMenu() passes the emitted signals from it's child forward
EWidget::addMenuByPass()
EDialog::addMenuByPass()

+ Here is the caller graph for this function:

void EObject::addNewDockWidget ( QDockWidget *  widget,
const Qt::DockWidgetArea &  area 
)
signal

Used to add the dock widget widget to the main window at the given area. The main window automatically adds an checkabe show and hide action to the view menu with the title of the widget.

See also
setCentralWidget()
addNewDockWidgetByPass()
EWidget::addNewDockWidget
EDialog::addNewDockWidget

+ Here is the caller graph for this function:

virtual void EObject::addNewDockWidgetByPass ( QDockWidget *  widget,
const Qt::DockWidgetArea &  area 
)
inlineprotectedvirtualslot
See also
addNewDockWidget() passes the emitted signals from it's child forward
EWidget::addNewDockWidgetByPass()
EDialog::addNewDockWidgetByPass()

+ Here is the caller graph for this function:

void EObject::addToolBar ( QToolBar *  newToolBar,
Qt::ToolBarArea  area = Qt::TopToolBarArea 
)
signal

Used to add the toolbar newToolBar to the main window.

See also
addMenu()
addAction()
addToolBarByPass()
EWidget::addToolBar()
EDialog::addToolBar()

+ Here is the caller graph for this function:

virtual void EObject::addToolBarByPass ( QToolBar *  newToolBar,
Qt::ToolBarArea  area = Qt::TopToolBarArea 
)
inlineprotectedvirtualslot
See also
addToolBar() passes the emitted signals from it's child forward
EWidget::addToolBarByPass()
EDialog::addToolBarByPass()

+ Here is the caller graph for this function:

void EObject::connectByPass ( QObject *  object)
inline

Connects all standard signals.

See also
EWidget::connectByPass()
EDialog::connectByPass()

+ Here is the caller graph for this function:

void EObject::connectByPass ( QObject *  parent,
QObject *  child 
)
static

Connects all standard signals between parent and child.

// this can be also an EWidget or EObject or EDialog
EWidget *child = new EWidget(this);
// connect all signals and slots as they must be connected

Normally you would call connectByPass(QObject*) and not this function directly

+ Here is the call graph for this function:

void EObject::doReloadSettings ( )
signal

Emitted to bring the reload request back to the farest child.

See also
reloadSettings()
reloadSettingsRequest()
EWidget::doReloadSettings()
EDialog::doReloadSettings()

+ Here is the caller graph for this function:

void EObject::error ( const QString &  message)
signal

The signals error(), warning() and information() are used to handle user information. error() should be used in critical situations. warning() is intendend to inform the user about not critical, but important facts. information() are only to inform the user, but they have no bad results. To let the main application decide, how they are displayed, only signals are emitted. This signal is used to notify about an error with message

See also
warning()
information()
errorByPass()
EWidget::error()
EDialog::error()

+ Here is the caller graph for this function:

virtual void EObject::errorByPass ( const QString &  message)
inlineprotectedvirtualslot
See also
error() if a child emits this signal, this class emits error() (it passes the childs signal upwards)
EWidget::errorByPass()
EDialog::errorByPass()

+ Here is the caller graph for this function:

void EObject::information ( const QString &  message)
signal

Used to notify about an information with message.

See also
error()
warning()
informationByPass()
EWidget::information()
EDialog::information()

+ Here is the caller graph for this function:

virtual void EObject::informationByPass ( const QString &  message)
inlineprotectedvirtualslot
See also
information() passes the emitted signals from it's child forward
EWidget::informationByPass()
EDialog::informationByPass()

+ Here is the caller graph for this function:

void EObject::reloadEnableActions ( )
signal

Request reloading of enabled actions in EMainWindow.

+ Here is the caller graph for this function:

virtual void EObject::reloadEnableActionsByPass ( )
inlineprotectedvirtualslot

Passes the reloadEnableActions() signals from it's childs forward.

+ Here is the caller graph for this function:

virtual void EObject::reloadSettings ( )
inlinevirtualslot

Used to reload the settings.

This function is connected to doReloadSettings() and should be used to actually do the reload of the settings. To indicate, that the settings should be reloaded, emit reloadSettingsRequest(). Use error to describe the error for the user. And don't forget to call the base implementation or emit doReloadSettings() yourself.

See also
doReloadSettings()
reloadSettingsRequest()
EWidget::reloadSettings()
EDialog::reloadSettings()

Reimplemented in ESqlLogin.

+ Here is the caller graph for this function:

void EObject::reloadSettingsRequest ( )
signal

Indicates, that a reload of the settings is needed.

Therefore this signal is used to bring the reload message upwards to the main window or whatever.

See also
reloadSettingsRequestByPass()
doReloadSettings()
reloadSettings()
EWidget::reloadSettingsRequest()
EDialog::reloadSettingsRequest()

+ Here is the caller graph for this function:

virtual void EObject::reloadSettingsRequestByPass ( )
inlineprotectedvirtualslot
See also
reloadSettingsRequest() passes the emitted signals from it's child forward.
reloadSettings()
reloadSettingsByPass()
doReloadSettings()

+ Here is the caller graph for this function:

void EObject::setCentralWidget ( QWidget *  centralWidget)
signal

Sets centralWidget as the new central widget.

Attention
old central widget is destroyed
See also
addNewDockWidget()
setCentralWidget()
EWidget::setCentralWidget()
EDialog::setCentralWidget()

+ Here is the caller graph for this function:

virtual void EObject::setCentralWidgetByPass ( QWidget *  centralWidget)
inlineprotectedvirtualslot
See also
setCentralWidget() passes the emitted signals from it's child forward
EWidget::setCentralWidgetbyPass()
EDialog::setCentralWidgetbyPass()

+ Here is the caller graph for this function:

void EObject::showHelp ( const QString &  page)
signal

help should be shown and page should be opened.

See also
showHelpByPass()
EWidget::showHelp()
EDialog::showHelp()

+ Here is the caller graph for this function:

virtual void EObject::showHelpByPass ( const QString &  page)
inlineprotectedvirtualslot
See also
showHelp() passes the emitted signals from it's child forward
EWidget::showHelpByPass()
EDialog::showHelpByPass()

+ Here is the caller graph for this function:

void EObject::showSettings ( )
signal

request to show the settings dialog.

See also
showSettingsByPass()
EWidget::showSettings()
EDialog::showSettings()

+ Here is the caller graph for this function:

virtual void EObject::showSettingsByPass ( )
inlineprotectedvirtualslot
See also
showSettings() passes the emitted signals from it's child forward
EWidget::showSettingsByPass()
EDialog::showSettingsByPass()

+ Here is the caller graph for this function:

void EObject::showStatusWidget ( QWidget *  widget)
signal

Adds widget to the status bar as a permanent widget.

See also
showStatusWidgetByPass()
EWidget::showStatusWidget()
EDialog::showStatusWidget()

+ Here is the caller graph for this function:

virtual void EObject::showStatusWidgetByPass ( QWidget *  widget)
inlineprotectedvirtualslot
See also
showStatusWidget() passes the emitted signals from it's child forward
EWidget::showStatusWidgetbyPass()
EDialog::showStatusWidgetbyPass()

+ Here is the caller graph for this function:

void EObject::warning ( const QString &  message)
signal

Used to notify about an warning with message.

See also
error()
information()
warningByPass()
EWidget::warning()
EDialog::warning()

+ Here is the caller graph for this function:

virtual void EObject::warningByPass ( const QString &  message)
inlineprotectedvirtualslot
See also
warning() passes the emitted signals from it's child forward
EWidget::warningByPass()
EDialog::warningByPass()

+ Here is the caller graph for this function:

Member Data Documentation

QList<QPointer<QAction> > EObject::dockActions
private
QList<QPointer<QDockWidget> > EObject::dockWidgets
private

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