Developer Documentation
Loading...
Searching...
No Matches
HelpWidget Class Reference
Inheritance diagram for HelpWidget:

Public Member Functions

 HelpWidget (QWidget *parent=0, const QString &_homeSite="", const bool _loadHomeSite=true)
 
void setHomeSite (const QString &_homeSite)
 

Private Slots

void startSearch ()
 
void goBack ()
 
void goForward ()
 
void goHome ()
 
void showSearchWidget ()
 
void linkActivated (const QUrl &_url)
 
void activateLink (const QUrl &_url)
 
void showFoundSite (const QUrl &_url)
 
void showResults (int _hits)
 
void update (const QUrl &url)
 
void openFoundSite (QListWidgetItem *_item)
 
void updateButtons ()
 

Private Attributes

QDockWidget * searchWidget_
 
QTabWidget * tabWidget_
 
HelpBrowsertextWindow_
 
QHelpEngine * helpEngine_
 
QHelpSearchEngine * searchEngine_
 
QString homeSite_
 
int homeIndex_
 

Detailed Description

Definition at line 59 of file helpWidget.hh.

Constructor & Destructor Documentation

◆ HelpWidget()

HelpWidget::HelpWidget ( QWidget *  parent = 0,
const QString &  _homeSite = "",
const bool  _loadHomeSite = true 
)

Definition at line 49 of file helpWidget.cc.

◆ ~HelpWidget()

HelpWidget::~HelpWidget ( )
virtual

Definition at line 323 of file helpWidget.cc.

Member Function Documentation

◆ activateLink

void HelpWidget::activateLink ( const QUrl &  _url)
privateslot

Definition at line 221 of file helpWidget.cc.

◆ goBack

void HelpWidget::goBack ( )
privateslot

Definition at line 273 of file helpWidget.cc.

◆ goForward

void HelpWidget::goForward ( )
privateslot

Definition at line 264 of file helpWidget.cc.

◆ goHome

void HelpWidget::goHome ( )
privateslot

Definition at line 282 of file helpWidget.cc.

◆ linkActivated

void HelpWidget::linkActivated ( const QUrl &  _url)
privateslot

Definition at line 227 of file helpWidget.cc.

◆ openFoundSite

void HelpWidget::openFoundSite ( QListWidgetItem *  _item)
privateslot

Definition at line 319 of file helpWidget.cc.

◆ setHomeSite()

void HelpWidget::setHomeSite ( const QString &  _homeSite)

Definition at line 238 of file helpWidget.cc.

◆ showFoundSite

void HelpWidget::showFoundSite ( const QUrl &  _url)
privateslot

Definition at line 243 of file helpWidget.cc.

◆ showResults

void HelpWidget::showResults ( int  _hits)
privateslot

Definition at line 311 of file helpWidget.cc.

◆ showSearchWidget

void HelpWidget::showSearchWidget ( )
privateslot

Definition at line 306 of file helpWidget.cc.

◆ startSearch

void HelpWidget::startSearch ( )
privateslot

Definition at line 233 of file helpWidget.cc.

◆ update

void HelpWidget::update ( const QUrl &  url)
privateslot

Definition at line 249 of file helpWidget.cc.

◆ updateButtons

void HelpWidget::updateButtons ( )
privateslot

Definition at line 291 of file helpWidget.cc.

Member Data Documentation

◆ helpEngine_

QHelpEngine* HelpWidget::helpEngine_
private

Definition at line 111 of file helpWidget.hh.

◆ homeIndex_

int HelpWidget::homeIndex_
private

Definition at line 116 of file helpWidget.hh.

◆ homeSite_

QString HelpWidget::homeSite_
private

Definition at line 114 of file helpWidget.hh.

◆ searchEngine_

QHelpSearchEngine* HelpWidget::searchEngine_
private

Definition at line 112 of file helpWidget.hh.

◆ searchWidget_

QDockWidget* HelpWidget::searchWidget_
private

Definition at line 105 of file helpWidget.hh.

◆ tabWidget_

QTabWidget* HelpWidget::tabWidget_
private

Definition at line 107 of file helpWidget.hh.

◆ textWindow_

HelpBrowser* HelpWidget::textWindow_
private

Definition at line 109 of file helpWidget.hh.


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