The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
gui::combo Class Reference

#include <combo.hpp>

Inheritance diagram for gui::combo:
Inheritance graph

Public Member Functions

 combo (CVideo &v, const std::vector< std::string > &items)
 
void set_selected (int val)
 
void set_items (const std::vector< std::string > &items)
 
int selected () const
 
bool changed ()
 
- Public Member Functions inherited from gui::button
 button (CVideo &video, const std::string &label, TYPE type=TYPE_PRESS, std::string button_image="", SPACE_CONSUMPTION spacing=DEFAULT_SPACE, const bool auto_join=true, std::string overlay_image="")
 
virtual ~button ()
 Default implementation, but defined out-of-line for efficiency reasons. More...
 
void set_check (bool check)
 
void set_active (bool active)
 
bool checked () const
 
void set_label (const std::string &val)
 
void set_image (const std::string &image_file_base)
 
void set_overlay (const std::string &image_file_base)
 
void set_image_path_suffix (const std::string &suffix)
 
bool pressed ()
 
bool hit (int x, int y) const
 
virtual void enable (bool new_val=true)
 
void release ()
 
- Public Member Functions inherited from gui::widget
SDL_Rect const & location () const
 
virtual void set_location (SDL_Rect const &rect)
 
void set_location (int x, int y)
 
void set_width (int w)
 
void set_height (int h)
 
void set_measurements (int w, int h)
 
int width () const
 
int height () const
 
bool focus (const SDL_Event *event)
 
void set_focus (bool focus)
 
virtual void hide (bool value=true)
 
bool hidden () const
 
bool enabled () const
 
void set_clip_rect (const SDL_Rect &rect)
 
void set_volatile (bool val=true)
 
void set_dirty (bool dirty=true)
 
bool dirty () const
 
const std::stringid () const
 
void set_id (const std::string &id)
 
void set_help_string (const std::string &str)
 
void set_tooltip_string (const std::string &str)
 
virtual void process_help_string (int mousex, int mousey)
 
virtual void process_tooltip_string (int mousex, int mousey)
 
- Public Member Functions inherited from events::sdl_handler
virtual bool requires_event_focus (const SDL_Event *=nullptr) const
 
virtual void join ()
 
virtual void join (context &c)
 
virtual void join_same (sdl_handler *parent)
 
virtual void leave ()
 
virtual void join_global ()
 
virtual void leave_global ()
 

Protected Member Functions

virtual void process_event ()
 
void make_drop_down_menu ()
 
- Protected Member Functions inherited from gui::button
virtual void handle_event (const SDL_Event &event)
 
virtual void mouse_motion (const SDL_MouseMotionEvent &event)
 
virtual void mouse_down (const SDL_MouseButtonEvent &event)
 
virtual void mouse_up (const SDL_MouseButtonEvent &event)
 
virtual void draw_contents ()
 
- Protected Member Functions inherited from gui::widget
 widget (widget const &o)
 
 widget (CVideo &video, const bool auto_join=true)
 
virtual ~widget ()
 
void bg_register (SDL_Rect const &rect)
 
void bg_restore () const
 
void bg_restore (SDL_Rect const &rect) const
 
void bg_update ()
 
void bg_cancel ()
 
CVideovideo () const
 
virtual void draw ()
 
virtual void update_location (SDL_Rect const &rect)
 
const SDL_Rect * clip_rect () const
 
virtual sdl_handler_vector member_handlers ()
 
virtual void handle_window_event (SDL_Event const &event)
 
bool mouse_locked () const
 
void aquire_mouse_lock ()
 
void free_mouse_lock ()
 
- Protected Member Functions inherited from events::sdl_handler
 sdl_handler (const bool auto_join=true)
 
virtual ~sdl_handler ()
 
virtual std::vector
< sdl_handler * > 
handler_members ()
 

Private Member Functions

void set_selected_internal (int val)
 

Private Attributes

std::vector< std::stringitems_
 
int selected_
 
int oldSelected_
 
CVideovideo_
 

Static Private Attributes

static const std::string empty_combo_label = ""
 
static const int font_size = font::SIZE_SMALL
 
static const int horizontal_padding = 10
 
static const int vertical_padding = 10
 

Additional Inherited Members

- Public Types inherited from gui::button
enum  TYPE {
  TYPE_PRESS, TYPE_CHECK, TYPE_TURBO, TYPE_IMAGE,
  TYPE_RADIO
}
 
enum  SPACE_CONSUMPTION { DEFAULT_SPACE, MINIMUM_SPACE }
 
- Protected Attributes inherited from gui::button
TYPE type_
 
- Protected Attributes inherited from gui::widget
bool focus_
 

Detailed Description

Definition at line 23 of file combo.hpp.

Constructor & Destructor Documentation

gui::combo::combo ( CVideo v,
const std::vector< std::string > &  items 
)

Definition at line 32 of file combo.cpp.

Member Function Documentation

bool gui::combo::changed ( )

Definition at line 43 of file combo.cpp.

References oldSelected_, and selected_.

Referenced by mp::create::process_event_impl(), and mp::configure::process_event_impl().

void gui::combo::make_drop_down_menu ( )
protected
void gui::combo::process_event ( )
protectedvirtual

Reimplemented from events::sdl_handler.

Reimplemented in gui::combo_drag.

Definition at line 82 of file combo.cpp.

References make_drop_down_menu(), and gui::button::pressed().

int gui::combo::selected ( ) const
void gui::combo::set_items ( const std::vector< std::string > &  items)
void gui::combo::set_selected ( int  val)
void gui::combo::set_selected_internal ( int  val)
private

Definition at line 58 of file combo.cpp.

References items_, oldSelected_, selected_, and gui::button::set_label().

Referenced by make_drop_down_menu(), and set_selected().

Member Data Documentation

const std::string gui::combo::empty_combo_label = ""
staticprivate

Definition at line 42 of file combo.hpp.

const int gui::combo::font_size = font::SIZE_SMALL
staticprivate

Definition at line 43 of file combo.hpp.

const int gui::combo::horizontal_padding = 10
staticprivate

Definition at line 44 of file combo.hpp.

std::vector<std::string> gui::combo::items_
private

Definition at line 39 of file combo.hpp.

Referenced by make_drop_down_menu(), set_items(), and set_selected_internal().

int gui::combo::oldSelected_
private

Definition at line 40 of file combo.hpp.

Referenced by changed(), set_selected(), and set_selected_internal().

int gui::combo::selected_
private

Definition at line 40 of file combo.hpp.

Referenced by changed(), selected(), set_items(), set_selected(), and set_selected_internal().

const int gui::combo::vertical_padding = 10
staticprivate

Definition at line 45 of file combo.hpp.

CVideo* gui::combo::video_
private

Definition at line 41 of file combo.hpp.

Referenced by make_drop_down_menu().


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