gui::HelpWindow Class Reference

Help window. More...

#include <helpwindow.h>

List of all members.

Public Slots

void goUrl ()
void setFile (const QString &fName)
void index ()
void setPage (QString name)

Public Member Functions

 HelpWindow (const QString &pageName=QString::null, QWidget *parent=0, const char *name=0)
 ~HelpWindow ()

Private Attributes

Q_TextBrowser * help
QString fileName
QLineEdit * url

Detailed Description

Help window.

class representing help window.
Help window is basically just a limited HTML browser

Constructor & Destructor Documentation

gui::HelpWindow::HelpWindow ( const QString &  pageName = QString::null,
QWidget *  parent = 0,
const char *  name = 0 
)

constructor of HelpWindow, creates window and fills it with elements, parameters are ignored

Parameters:
pageName Name of page to open in help window initially
parent Parent of this window
name Name of this window (for debugging)

References APP_NAME, gui::globalSettings, goUrl(), help, index(), Q_TextBrowser, gui::Settings::readPath(), gui::Settings::restoreWindow(), setPage(), and url.

gui::HelpWindow::~HelpWindow (  ) 

default destructor

References gui::globalSettings, help, and gui::Settings::saveWindow().

Member Function Documentation

void gui::HelpWindow::goUrl (  )  [slot]

Try to go to URL that is typed in the location box

References setFile(), and url.

Referenced by HelpWindow().

void gui::HelpWindow::index (  )  [slot]

Navigate to index page of the help

References setPage().

Referenced by HelpWindow().

void gui::HelpWindow::setFile ( const QString &  fName  )  [slot]

Navigate to certain fileName

Parameters:
fName Name of file to show in help

References fileName, help, and url.

Referenced by goUrl(), and setPage().

void gui::HelpWindow::setPage ( QString  name  )  [slot]

Navigate to certain page of the help

Parameters:
name Name of page to show in help

References setFile().

Referenced by HelpWindow(), and index().

Member Data Documentation

QString gui::HelpWindow::fileName [private]

Name of file loaded into help

Referenced by setFile().

Q_TextBrowser* gui::HelpWindow::help [private]

Rich text browser with hypertext navigation. Core of this help window

Referenced by HelpWindow(), setFile(), and ~HelpWindow().

QLineEdit* gui::HelpWindow::url [private]

Line edit control used to show/edit name of current file

Referenced by goUrl(), HelpWindow(), and setFile().

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