Class that interfaces with the documentation window ui. More...
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 |
Class that interfaces with the documentation window ui.
rtVTK::Documentation::Documentation | ( | QMainWindow * | parent = 0 | ) | [explicit] |
Initializes the ui and directs the webview to the default documentation directory index file.
parent | QMainWindow* - 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.
url | const QUrl& - The url with respect to the directory stored in the configuration. |
parent | QMainWindow* - Pointer to the parent object. |
References ui.
Destroys the ui object pointer.
References ui.
void rtVTK::Documentation::closeEvent | ( | QCloseEvent * | e | ) | [private] |
Restores idling after closing the window.
References sgnlRestoreIdle(), and sgnlUnpauseTimers().
void rtVTK::Documentation::setPath | ( | const QUrl & | url | ) |
Sets the webView display url.
References ui.
Referenced by Documentation(), rtVTK::MainWindow::slotShowMainDocs(), rtVTK::MainWindow::slotShowUsingDocs(), and rtVTK::MainWindow::slotShowWritingDocs().
void rtVTK::Documentation::sgnlDisableIdle | ( | ) | [signal] |
Referenced by showEvent().
void rtVTK::Documentation::sgnlPauseTimers | ( | ) | [signal] |
Referenced by showEvent().
void rtVTK::Documentation::sgnlRestoreIdle | ( | ) | [signal] |
Referenced by closeEvent().
void rtVTK::Documentation::sgnlUnpauseTimers | ( | ) | [signal] |
Referenced by closeEvent().
void rtVTK::Documentation::showEvent | ( | QShowEvent * | e | ) | [private] |
Disables idling while showing the window.
References sgnlDisableIdle(), and sgnlPauseTimers().
QToolButton* rtVTK::Documentation::backButton [private] |
Referenced by Documentation().
QShortcut* rtVTK::Documentation::escapeOverloaded [private] |
Referenced by Documentation().
QToolButton* rtVTK::Documentation::forwardButton [private] |
Referenced by Documentation().
Ui::Documentation* rtVTK::Documentation::ui [private] |
Referenced by Documentation(), setPath(), and ~Documentation().