LibEngsas
Public Slots | Public Member Functions | Private Member Functions | Private Attributes | List of all members
EHelpCenter Class Reference

Manage the QtAssistant usage to display the online help. More...

#include <ehelpcenter.h>

+ Inheritance diagram for EHelpCenter:
+ Collaboration diagram for EHelpCenter:

Public Slots

void showDocumentation (QString page=QString())
 
- Public Slots inherited from EObject
virtual void reloadSettings ()
 Used to reload the settings. More...
 

Public Member Functions

 EHelpCenter (EHelpCenterSetup setup, QObject *parent)
 
 ~EHelpCenter ()
 
- Public Member Functions inherited from EObject
 EObject (QObject *parent=0)
 
virtual ~EObject ()
 
void connectByPass (QObject *object)
 

Private Member Functions

QString fileForLang (QStringList files)
 Returns a file of files for current language. More...
 
bool startAssistant ()
 

Private Attributes

QProcess * assistantProcess
 
EHelpCenterSetup settings
 
QFileInfo qhcFile
 
QList< QFileInfo > qchFiles
 

Additional Inherited Members

- Signals inherited from EObject
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...
 
- Static Public Member Functions inherited from EObject
static void connectByPass (QObject *parent, QObject *child)
 
- Protected Slots inherited from EObject
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 inherited from EObject
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...
 

Detailed Description

Manage the QtAssistant usage to display the online help.

It starts QtAssistant and tries to load the given documentation collection. A specific page inside the documentation collection can be shown with showDocumentation()

Constructor & Destructor Documentation

EHelpCenter::EHelpCenter ( EHelpCenterSetup  setup,
QObject *  parent 
)
EHelpCenter::~EHelpCenter ( )

Member Function Documentation

QString EHelpCenter::fileForLang ( QStringList  files)
private

Returns a file of files for current language.

If no file for current language is found, the english version is returned. If that version is also not found, an empty string is returned.

+ Here is the caller graph for this function:

void EHelpCenter::showDocumentation ( QString  page = QString())
slot
Parameters
pageif page starts with keyword: then a the part after : is used as a keyword

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool EHelpCenter::startAssistant ( )
private

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

QProcess* EHelpCenter::assistantProcess
private
QList<QFileInfo> EHelpCenter::qchFiles
private
QFileInfo EHelpCenter::qhcFile
private
EHelpCenterSetup EHelpCenter::settings
private

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