Aseba::HelpViewer Class Reference

#include <HelpViewer.h>

List of all members.

Public Types
enum	helpType { USERMANUAL, STUDIO, LANGUAGE }
Public Member Functions
	HelpViewer (QWidget *parent=0)
void	setLanguage (const QString &lang=DEFAULT_LANGUAGE)
void	showHelp (helpType type)
	~HelpViewer ()
Static Public Attributes
static const QString	DEFAULT_LANGUAGE = "en"
Protected Slots
void	backwardAvailable (bool state)
void	forwardAvailable (bool state)
void	homeClicked ()
void	nextClicked ()
void	previousClicked ()
Protected Member Functions
bool	readSettings ()
bool	selectLanguage (const QString &reqLang)
void	writeSettings ()
Protected Attributes
QHelpEngine *	helpEngine
bool	helpFound
QPushButton *	home
QString	language
QPushButton *	next
QPushButton *	previous
const QString	tmpHelpFileNameCH
const QString	tmpHelpFileNameHC
const QString	tmpHelpSubDir
HelpBrowser *	viewer

---

Detailed Description

Definition at line 34 of file HelpViewer.h.

---

Member Enumeration Documentation

enum Aseba::HelpViewer::helpType

Enumerator:

USERMANUAL
STUDIO
LANGUAGE

Definition at line 42 of file HelpViewer.h.

---

Constructor & Destructor Documentation

Aseba::HelpViewer::HelpViewer

(

QWidget *

parent = 0

)

Definition at line 45 of file HelpViewer.cpp.

Aseba::HelpViewer::~HelpViewer

(

)

Definition at line 117 of file HelpViewer.cpp.

---

Member Function Documentation

void Aseba::HelpViewer::backwardAvailable

(

bool

state

)

[protected, slot]

Definition at line 212 of file HelpViewer.cpp.

void Aseba::HelpViewer::forwardAvailable

(

bool

state

)

[protected, slot]

Definition at line 222 of file HelpViewer.cpp.

void Aseba::HelpViewer::homeClicked

(

)

[protected, slot]

Definition at line 227 of file HelpViewer.cpp.

void Aseba::HelpViewer::nextClicked

(

)

[protected, slot]

Definition at line 217 of file HelpViewer.cpp.

void Aseba::HelpViewer::previousClicked

(

)

[protected, slot]

Definition at line 207 of file HelpViewer.cpp.

bool Aseba::HelpViewer::readSettings

(

)

[protected]

Definition at line 189 of file HelpViewer.cpp.

bool Aseba::HelpViewer::selectLanguage

(

const QString &

reqLang

)

[protected]

Definition at line 144 of file HelpViewer.cpp.

void Aseba::HelpViewer::setLanguage

(

const QString &

lang = DEFAULT_LANGUAGE

)

Definition at line 126 of file HelpViewer.cpp.

void Aseba::HelpViewer::showHelp

(

helpType

type

)

Definition at line 160 of file HelpViewer.cpp.

void Aseba::HelpViewer::writeSettings

(

)

[protected]

Definition at line 199 of file HelpViewer.cpp.

---

Member Data Documentation

const QString Aseba::HelpViewer::DEFAULT_LANGUAGE = "en" [static]

Definition at line 48 of file HelpViewer.h.

QHelpEngine* Aseba::HelpViewer::helpEngine [protected]

Definition at line 58 of file HelpViewer.h.

bool Aseba::HelpViewer::helpFound [protected]

Definition at line 64 of file HelpViewer.h.

QPushButton* Aseba::HelpViewer::home [protected]

Definition at line 62 of file HelpViewer.h.

QString Aseba::HelpViewer::language [protected]

Definition at line 63 of file HelpViewer.h.

QPushButton* Aseba::HelpViewer::next [protected]

Definition at line 61 of file HelpViewer.h.

QPushButton* Aseba::HelpViewer::previous [protected]

Definition at line 60 of file HelpViewer.h.

const QString Aseba::HelpViewer::tmpHelpFileNameCH [protected]

Definition at line 67 of file HelpViewer.h.

const QString Aseba::HelpViewer::tmpHelpFileNameHC [protected]

Definition at line 66 of file HelpViewer.h.

const QString Aseba::HelpViewer::tmpHelpSubDir [protected]

Definition at line 65 of file HelpViewer.h.

HelpBrowser* Aseba::HelpViewer::viewer [protected]

Definition at line 59 of file HelpViewer.h.

---

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

• HelpViewer.h
• HelpViewer.cpp