rtVTK  0.6.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
Signals | Public Member Functions | Private Member Functions | Private Attributes
rtVTK::Documentation Class Reference

Class that interfaces with the documentation window ui. More...

List of all members.

Signals

void sgnlRestoreIdle ()
void sgnlDisableIdle ()
void sgnlPauseTimers ()
void sgnlUnpauseTimers ()

Public Member Functions

 Documentation (QMainWindow *=0)
 Documentation (const QUrl &, QMainWindow *=0)
 ~Documentation ()
void setPath (const QUrl &)

Private Member Functions

void showEvent (QShowEvent *)
void closeEvent (QCloseEvent *)

Private Attributes

Ui::Documentation * ui
QShortcut * escapeOverloaded
Forward and Back buttons.
QToolButton * backButton
QToolButton * forwardButton

Detailed Description

Class that interfaces with the documentation window ui.


Constructor & Destructor Documentation

rtVTK::Documentation::Documentation ( QMainWindow *  parent = 0) [explicit]

Initializes the ui and directs the webview to the default documentation directory index file.

Parameters:
parentQMainWindow* - Pointer to the parent object.

References backButton, escapeOverloaded, forwardButton, setPath(), and ui.

rtVTK::Documentation::Documentation ( const QUrl &  url,
QMainWindow *  parent = 0 
) [explicit]

Initializes the ui and directs the webview to the configured documentation directory index file url.

Parameters:
urlconst QUrl& - The url with respect to the directory stored in the configuration.
parentQMainWindow* - Pointer to the parent object.

References ui.

Destroys the ui object pointer.

References ui.


Member Function Documentation

void rtVTK::Documentation::closeEvent ( QCloseEvent *  e) [private]

Restores idling after closing the window.

References sgnlRestoreIdle(), and sgnlUnpauseTimers().

void rtVTK::Documentation::setPath ( const QUrl &  url)

Referenced by showEvent().

Referenced by showEvent().

Referenced by closeEvent().

Referenced by closeEvent().

void rtVTK::Documentation::showEvent ( QShowEvent *  e) [private]

Disables idling while showing the window.

References sgnlDisableIdle(), and sgnlPauseTimers().


Member Data Documentation

QToolButton* rtVTK::Documentation::backButton [private]

Referenced by Documentation().

Referenced by Documentation().

QToolButton* rtVTK::Documentation::forwardButton [private]

Referenced by Documentation().

Ui::Documentation* rtVTK::Documentation::ui [private]

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends