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 ()
bool	showUsersGuide (QString chapter="", QWidget *helpWidget=nullptr)

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

Private Attributes
QUrl	_homeUrl

Detailed Description

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

Copyright (c) 2009, 2016 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::CAHelpCtl

(

)

Initializes Help and loads User's guide.

References _homeUrl, and detectHomeUrl().

Here is the call graph for this function:

~CAHelpCtl()

CAHelpCtl::~CAHelpCtl ( )

virtual

Member Function Documentation

detectHomeUrl()

QUrl CAHelpCtl::detectHomeUrl ( )

private

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

Referenced by CAHelpCtl().

Here is the caller graph for this function:

displayHelp()

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

private

Activates the user's guide help at the given url.

Referenced by showUsersGuide().

Here is the caller graph for this function:

showUsersGuide()

bool CAHelpCtl::showUsersGuide	(	QString	chapter = "",
		QWidget *	helpWidget = nullptr
	)

Show user's guide at the given chapter.

Returns

True, if a user's guide was found and shown; False otherwise.

References _homeUrl, and displayHelp().

Referenced by CAMainWin::on_uiUsersGuide_triggered().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_homeUrl

QUrl CAHelpCtl::_homeUrl

private

Referenced by CAHelpCtl(), and showUsersGuide().

---

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

• /home/iurt/rpmbuild/BUILD/canorus-0.7.3svn20190422/src/control/helpctl.h
• /home/iurt/rpmbuild/BUILD/canorus-0.7.3svn20190422/src/control/helpctl.cpp