pawsHelp Class Reference

#include <pawshelp.h>

List of all members.

Public Member Functions
bool	OnSelected (pawsWidget *widget)
	Called whenever a widget is selected.
	pawsHelp ()
bool	PostSetup ()
	This is called after the widget and all of it's children have been created.
	~pawsHelp ()
Protected Member Functions
void	LoadHelps (iDocumentNode *node, csString parent)
csRef< iDocumentNode >	RetrieveHelp (pawsTreeNode *node, csRef< iDocumentNode > helpRoot)
Protected Attributes
csRef< iDocument >	helpDoc
pawsDocumentView *	helpText
pawsSimpleTree *	helpTree
csRef< iVFS >	vfs

---

Detailed Description

Definition at line 32 of file pawshelp.h.

---

Constructor & Destructor Documentation

pawsHelp::pawsHelp

(

)

pawsHelp::~pawsHelp

(

)

---

Member Function Documentation

void pawsHelp::LoadHelps	(	iDocumentNode *	node,
		csString	parent
	)		[protected]

bool pawsHelp::OnSelected

(

pawsWidget *

widget

)

[virtual]

Called whenever a widget is selected.

Parameters:

widget

The selected widget.

Returns:

bool

Reimplemented from pawsWidget.

bool pawsHelp::PostSetup

(

)

[virtual]

This is called after the widget and all of it's children have been created.

Remarks:

This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented from pawsWidget.

csRef<iDocumentNode> pawsHelp::RetrieveHelp	(	pawsTreeNode *	node,
		csRef< iDocumentNode >	helpRoot
	)		[protected]

---

Member Data Documentation

csRef<iDocument> pawsHelp::helpDoc [protected]

Definition at line 46 of file pawshelp.h.

pawsDocumentView* pawsHelp::helpText [protected]

Definition at line 49 of file pawshelp.h.

pawsSimpleTree* pawsHelp::helpTree [protected]

Definition at line 48 of file pawshelp.h.

csRef<iVFS> pawsHelp::vfs [protected]

Definition at line 45 of file pawshelp.h.

---

The documentation for this class was generated from the following file:

• client/gui/pawshelp.h