help::help_button Class Reference

#include <help.hpp>

Inheritance diagram for help::help_button:

Collaboration diagram for help::help_button:

List of all members.

Public Member Functions
	help_button (display &disp, const std::string &help_topic)
	~help_button ()
int	action (gui::dialog_process_info &info)
std::string	topic () const
void	join ()
void	leave ()
Private Member Functions
void	show_help ()
bool	can_execute_command (hotkey::HOTKEY_COMMAND cmd, int=-1) const
Private Attributes
display &	disp_
const std::string	topic_
hotkey::basic_handler *	help_hand_

---

Detailed Description

Definition at line 48 of file help.hpp.

---

Constructor & Destructor Documentation

help::help_button::help_button	(	display &	disp,
		const std::string &	help_topic
	)

Definition at line 50 of file help.cpp.

help::help_button::~help_button

(

)

Definition at line 54 of file help.cpp.

References help_hand_.

---

Member Function Documentation

int help::help_button::action

(

gui::dialog_process_info &

info

)

Definition at line 58 of file help.cpp.

References gui::dialog_process_info::clear_buttons(), show_help(), and topic_.

Here is the call graph for this function:

bool help::help_button::can_execute_command	(	hotkey::HOTKEY_COMMAND	cmd,
		int	= -1
	)			const [private, virtual]

Implements hotkey::command_executor.

Definition at line 71 of file help.cpp.

References hotkey::HOTKEY_SCREENSHOT, and topic_.

void help::help_button::join

(

)

Definition at line 76 of file help.cpp.

References disp_, and help_hand_.

void help::help_button::leave

(

)

Definition at line 84 of file help.cpp.

References help_hand_.

void help::help_button::show_help

(

)

[private, virtual]

Reimplemented from hotkey::command_executor.

Definition at line 66 of file help.cpp.

References disp_, and topic_.

Referenced by action().

Here is the caller graph for this function:

std::string help::help_button::topic

(

)

const [inline]

Definition at line 53 of file help.hpp.

References topic_.

---

Member Data Documentation

display& help::help_button::disp_ [private]

Definition at line 60 of file help.hpp.

Referenced by join(), and show_help().

hotkey::basic_handler* help::help_button::help_hand_ [private]

Definition at line 62 of file help.hpp.

Referenced by join(), leave(), and ~help_button().

const std::string help::help_button::topic_ [private]

Definition at line 61 of file help.hpp.

Referenced by action(), can_execute_command(), show_help(), and topic().

---

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

• help.hpp
• help.cpp