00001 //# TBHelp.qo.h: Widget for displaying and updating the browser help files. 00002 //# Copyright (C) 2005 00003 //# Associated Universities, Inc. Washington DC, USA. 00004 //# 00005 //# This library is free software; you can redistribute it and/or modify it 00006 //# under the terms of the GNU Library General Public License as published by 00007 //# the Free Software Foundation; either version 2 of the License, or (at your 00008 //# option) any later version. 00009 //# 00010 //# This library is distributed in the hope that it will be useful, but WITHOUT 00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00012 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public 00013 //# License for more details. 00014 //# 00015 //# You should have received a copy of the GNU Library General Public License 00016 //# along with this library; if not, write to the Free Software Foundation, 00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA. 00018 //# 00019 //# Correspondence concerning AIPS++ should be addressed as follows: 00020 //# Internet email: aips2-request@nrao.edu. 00021 //# Postal address: AIPS++ Project Office 00022 //# National Radio Astronomy Observatory 00023 //# 520 Edgemont Road 00024 //# Charlottesville, VA 22903-2475 USA 00025 //# 00026 //# $Id: $#ifndef TBHELP_H_ 00027 #ifndef TBHELP_H_ 00028 #define TBHELP_H_ 00029 00030 #include <casaqt/QtBrowser/TBHelp.ui.h> 00031 00032 #include <QtGui> 00033 00034 #include <casa/BasicSL/String.h> 00035 00036 namespace casa { 00037 00038 // <summary> 00039 // Widget for displaying and updating the browser help files. 00040 // <summary> 00041 // 00042 // <synopsis> 00043 // TBHelp first finds the help files (which should be located under 00044 // %casadir%/code/casaqt/implement/QtBrowser/help/) and checks the modification 00045 // date. The meta help information is located in help.xml, which is then 00046 // converted into html files (like browsing.html) if help.xml has been modified 00047 // after the html files. The HTML is then displayed using a QTextBrowser, 00048 // allowing the user to browse. 00049 // </synopsis> 00050 00051 class TBHelp : public QWidget, Ui::Help { 00052 Q_OBJECT 00053 00054 public: 00055 // Default Constructor. 00056 TBHelp(); 00057 00058 ~TBHelp(); 00059 00060 00061 // Rebuilds the HTML files based on the XML file. Returns true if the 00062 // rebuild succeeded, false otherwise. 00063 bool rebuild(); 00064 00065 private slots: 00066 // Slot for when the rebuild button is clicked. If the rebuild is 00067 // successful, the help browser is reloaded to display the most recent 00068 // version. 00069 void rebuildClicked(); 00070 00071 private: 00072 // Location of the directory holding the help files. 00073 String helpdir; 00074 }; 00075 00076 } 00077 00078 #endif /* TBHELP_H_ */