casa
$Rev:20696$
|
Widget for displaying and updating the browser help files. More...
#include <TBHelp.qo.h>
Public Member Functions | |
TBHelp () | |
Default Constructor. | |
~TBHelp () | |
bool | rebuild () |
Rebuilds the HTML files based on the XML file. | |
Private Slots | |
void | rebuildClicked () |
Slot for when the rebuild button is clicked. | |
Private Attributes | |
String | helpdir |
Location of the directory holding the help files. |
Widget for displaying and updating the browser help files.
TBHelp first finds the help files (which should be located under casadir%/code/casaqt/implement/QtBrowser/help/) and checks the modification date. The meta help information is located in help.xml, which is then converted into html files (like browsing.html) if help.xml has been modified after the html files. The HTML is then displayed using a QTextBrowser, allowing the user to browse.
Definition at line 53 of file TBHelp.qo.h.
Default Constructor.
bool casa::TBHelp::rebuild | ( | ) |
Rebuilds the HTML files based on the XML file.
Returns true if the rebuild succeeded, false otherwise.
void casa::TBHelp::rebuildClicked | ( | ) | [private, slot] |
Slot for when the rebuild button is clicked.
If the rebuild is successful, the help browser is reloaded to display the most recent version.
String casa::TBHelp::helpdir [private] |
Location of the directory holding the help files.
Definition at line 75 of file TBHelp.qo.h.