help::help_button Class Reference

#include <help.hpp>

Inheritance diagram for help::help_button:

Inheritance graph
[legend]
Collaboration diagram for help::help_button:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 help_button (display &disp, const std::string &help_topic)
int action (gui::dialog_process_info &info)
const 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

displaydisp_
const std::string topic_
hotkey::basic_handlerhelp_hand_


Detailed Description

Definition at line 50 of file help.hpp.


Constructor & Destructor Documentation

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

Definition at line 61 of file help.cpp.


Member Function Documentation

int help::help_button::action ( gui::dialog_process_info info  )  [virtual]

Reimplemented from gui::dialog_button.

Definition at line 65 of file help.cpp.

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

const std::string help::help_button::topic (  )  const [inline]

Definition at line 54 of file help.hpp.

References topic_.

void help::help_button::join (  )  [virtual]

Reimplemented from events::handler.

Definition at line 83 of file help.cpp.

References disp_, help_hand_, and utils::join().

void help::help_button::leave (  )  [virtual]

Reimplemented from events::handler.

Definition at line 91 of file help.cpp.

References help_hand_.

void help::help_button::show_help (  )  [private, virtual]

Reimplemented from hotkey::command_executor.

Definition at line 73 of file help.cpp.

References disp_, help::show_help(), and topic_.

Referenced by action().

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

Implements hotkey::command_executor.

Definition at line 78 of file help.cpp.

References hotkey::HOTKEY_HELP, hotkey::HOTKEY_SCREENSHOT, and topic_.


Member Data Documentation

Definition at line 61 of file help.hpp.

Referenced by join(), and show_help().

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

Definition at line 62 of file help.hpp.

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

Definition at line 63 of file help.hpp.

Referenced by join(), and leave().


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

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs