Logo Search packages:      
Sourcecode: wesnoth version File versions

help::help_menu Class Reference

Inheritance diagram for help::help_menu:

List of all members.

Detailed Description

The menu to the left in the help browser, where topics can be navigated through and chosen.

Definition at line 170 of file help.cpp.

Public Member Functions

void change_item (int pos1, int pos2, std::string str)
const topicchosen_topic ()
bool dirty () const
bool double_clicked ()
void erase_item (size_t index)
virtual bool focus () const
unsigned height () const
 help_menu (CVideo &video, const section &toplevel, int max_height=-1)
bool hidden () const
virtual void hide (bool value=true)
SDL_Rect const & location () const
void move_selection (size_t pos)
size_t nitems () const
int process ()
virtual bool requires_event_focus () const
void scroll (int pos)
void select_topic (const topic &t)
int selection () const
void set_clip_rect (const SDL_Rect &rect)
void set_dirty (bool dirty=true)
void set_focus (bool focus)
void set_height (unsigned h)
void set_help_string (const std::string &str)
void set_items (const std::vector< std::string > &items, bool strip_spaces=true, bool keep_viewport=false)
void set_location (int x, int y)
virtual void set_location (SDL_Rect const &rect)
void set_max_height (const int new_max_height)
void set_max_width (const int new_max_width)
void set_measurements (unsigned w, unsigned h)
void set_numeric_keypress_selection (bool value)
void set_volatile (bool val=true)
void set_width (unsigned w)
unsigned width () const

Protected Member Functions

void adjust_position (unsigned pos)
void bg_cancel ()
void bg_register (SDL_Rect const &rect)
void bg_restore (SDL_Rect const &rect) const
void bg_restore () const
void bg_update ()
virtual void draw ()
unsigned get_max_position () const
unsigned get_position () const
void handle_event (const SDL_Event &event)
bool has_scrollbar () const
SDL_Rect inner_location () const
void move_position (int dep)
virtual void process_event ()
unsigned scrollbar_width () const
void set_full_size (unsigned h)
void set_inner_location (const SDL_Rect &rect)
void set_position (unsigned pos)
void set_scroll_rate (unsigned r)
void set_shown_size (unsigned h)
virtual void update_location (SDL_Rect const &rect)
CVideo & video () const

Private Member Functions

void contract (const section &sec)
void display_visible_items ()
 Draw the currently visible items.
void expand (const section &sec)
bool expanded (const section &sec)
 Return true if the section is expanded.
std::string get_string_to_show (const topic &topic, const unsigned level)
std::string get_string_to_show (const section &sec, const unsigned level)
bool select_topic_internal (const topic &t, const section &sec)
void update_visible_items (const section &top_level, unsigned starting_level=0)

Private Attributes

topic const * chosen_topic_
std::set< const section * > expanded_
SDL_Rect rect_
surface_restorer restorer_
visible_item selected_item_
const sectiontoplevel_
std::vector< visible_itemvisible_items_


struct  visible_item
 Information about an item that is visible in the menu. More...

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

Generated by  Doxygen 1.6.0   Back to index