CAHelpCtl Class Reference

Class for showing User's guide, What's new, Did you know tips etc. More...

#include <helpctl.h>

Public Member Functions
	CAHelpCtl ()
virtual	~CAHelpCtl ()
void	showUsersGuide (QString chapter="", QWidget *helpWidget=0)

Private Member Functions
void	displayHelp (QUrl url, QWidget *helpWidget)
QString	usersGuideLanguage ()

Private Attributes
QHelpEngine *	_helpEngine

Detailed Description

Class for showing User's guide, What's new, Did you know tips etc.

Copyright (c) 2009, Matevž Jekovec, Canorus development team All Rights Reserved. See AUTHORS for a complete list of authors.

Licensed under the GNU GENERAL PUBLIC LICENSE. See COPYING for details.

Constructor & Destructor Documentation

CAHelpCtl::CAHelpCtl

(

)

Initializes Help and loads User's guide.

References _helpEngine, and usersGuideLanguage().

Here is the call graph for this function:

CAHelpCtl::~CAHelpCtl ( )

virtual

Member Function Documentation

void CAHelpCtl::displayHelp ( QUrl  url, QWidget *  helpWidget  )

private

References _helpEngine, CAHelpBrowser::setHelpEngine(), and CAHelpBrowser::setSource().

Referenced by showUsersGuide().

Here is the call graph for this function:

Here is the caller graph for this function:

void CAHelpCtl::showUsersGuide	(	QString	chapter = "",
		QWidget *	helpWidget = 0
	)

Loads user's guide file

References _helpEngine, displayHelp(), and usersGuideLanguage().

Referenced by CAMainWin::on_uiUsersGuide_triggered().

Here is the call graph for this function:

Here is the caller graph for this function:

QString CAHelpCtl::usersGuideLanguage ( )

private

Helper function which returns the existent User's guide language.

Referenced by CAHelpCtl(), and showUsersGuide().

Here is the caller graph for this function:

Member Data Documentation

QHelpEngine* CAHelpCtl::_helpEngine

private

Referenced by CAHelpCtl(), displayHelp(), and showUsersGuide().

---

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

• /home/iurt/rpmbuild/BUILD/canorus-0.7.R1002/src/control/helpctl.h
• /home/iurt/rpmbuild/BUILD/canorus-0.7.R1002/src/control/helpctl.cpp