Planeshift
pawshelp.h
Go to the documentation of this file.
1 /*
2  * pawshelp.h - Author: Andrew Dai
3  *
4  * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
5  *
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation (version 2 of the License)
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17  *
18  */
19 #ifndef PAWS_HELP_WINDOW_HEADER
20 #define PAWS_HELP_WINDOW_HEADER
21 
22 #include <csutil/xmltiny.h>
23 #include <csutil/csstring.h>
24 #include <csutil/refcount.h>
25 
26 #include "paws/pawswidget.h"
27 #include "paws/pawstree.h"
28 #include "gui/pawscontrolwindow.h"
29 
30 class pawsProgressBar;
31 
36 {
37 public:
38  pawsHelp();
39  ~pawsHelp();
40 
41  bool PostSetup();
42  bool OnSelected(pawsWidget* widget);
43 
44 protected:
45  void LoadHelps(iDocumentNode* node, csString parent);
46  csRef<iDocumentNode> RetrieveHelp(pawsTreeNode* node, csRef<iDocumentNode> helpRoot);
47 
48  csRef<iVFS> vfs;
49  csRef<iDocument> helpDoc;
50  //BinaryRBTree<csString> helpIndex;
53 };
54 
56 
57 
58 #endif
This is a window that is controlled by a button on the control bar.
bool PostSetup()
This is called after the widget and all of it&#39;s children have been created.
The main base widget that all other widgets should inherit from.
Definition: pawswidget.h:116
Help window, with tree of topics on the left, and description on the right panel. ...
Definition: pawshelp.h:35
CREATE_PAWS_FACTORY(pawsHelp)
pawsSimpleTree * helpTree
Definition: pawshelp.h:51
pawsWidget * parent
This widget&#39;s parent.
Definition: pawswidget.h:130
csRef< iVFS > vfs
Definition: pawshelp.h:48
csRef< iDocument > helpDoc
Definition: pawshelp.h:49
csRef< iDocumentNode > RetrieveHelp(pawsTreeNode *node, csRef< iDocumentNode > helpRoot)
bool OnSelected(pawsWidget *widget)
Called whenever a widget is selected.
pawsDocumentView * helpText
Definition: pawshelp.h:52
void LoadHelps(iDocumentNode *node, csString parent)