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

Used by the combobox widget. More...

#include <drop_down_list.hpp>

Inheritance diagram for gui2::tdrop_down_list:
Inheritance graph

Public Member Functions

 tdrop_down_list (SDL_Rect button_pos, const std::vector< std::string > &items, int selected_item, bool use_markup)
 
int selected_item () const
 
- Public Member Functions inherited from gui2::tdialog
 tdialog ()
 
virtual ~tdialog ()
 
bool show (CVideo &video, const unsigned auto_close_time=0)
 Shows the window. More...
 
int get_retval () const
 
void set_always_save_fields (const bool always_save_fields)
 
void set_restore (const bool restore)
 

Private Member Functions

virtual const std::stringwindow_id () const
 Inherited from tdialog, implemented by REGISTER_DIALOG. More...
 
void pre_show (twindow &window)
 Inherited from tdialog. More...
 
void post_show (twindow &window)
 Inherited from tdialog. More...
 
void item_change_callback (twindow &window, size_t item)
 

Private Attributes

SDL_Rect button_pos_
 The screen location of the combobox button that triggred this droplist. More...
 
std::vector< std::stringitems_
 
int selected_item_
 
bool use_markup_
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::tdialog
tfield_boolregister_bool (const std::string &id, const bool mandatory, const std::function< bool()> &callback_load_value=std::function< bool()>(), const std::function< void(const bool)> &callback_save_value=std::function< void(const bool)>(), const std::function< void(twidget &)> &callback_change=std::function< void(twidget &)>())
 Creates a new boolean field. More...
 
tfield_boolregister_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(twidget &)> &callback_change=std::function< void(twidget &)>())
 Creates a new boolean field. More...
 
tfield_integerregister_integer (const std::string &id, const bool mandatory, const std::function< int()> &callback_load_value=std::function< int()>(), const std::function< void(const int)> &callback_save_value=std::function< void(const int)>())
 Creates a new integer field. More...
 
tfield_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
tfield_textregister_text (const std::string &id, const bool mandatory, const std::function< std::string()> &callback_load_value=std::function< std::string()>(), const std::function< void(const std::string &)> &callback_save_value=std::function< void(const std::string &)>(), const bool capture_focus=false)
 Creates a new text field. More...
 
tfield_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
tfield_labelregister_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
 Registers a new control as a label. More...
 
tfield_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new control as image. More...
 

Detailed Description

Used by the combobox widget.

Definition at line 23 of file drop_down_list.hpp.

Constructor & Destructor Documentation

gui2::tdrop_down_list::tdrop_down_list ( SDL_Rect  button_pos,
const std::vector< std::string > &  items,
int  selected_item,
bool  use_markup 
)
inline

Definition at line 26 of file drop_down_list.hpp.

Member Function Documentation

void gui2::tdrop_down_list::item_change_callback ( twindow window,
size_t  item 
)
private
void gui2::tdrop_down_list::post_show ( twindow window)
privatevirtual

Inherited from tdialog.

Reimplemented from gui2::tdialog.

Definition at line 79 of file drop_down_list.cpp.

void gui2::tdrop_down_list::pre_show ( twindow window)
privatevirtual
int gui2::tdrop_down_list::selected_item ( ) const
inline

Definition at line 33 of file drop_down_list.hpp.

References selected_item_.

Referenced by gui2::tcombobox::signal_handler_left_button_click().

virtual const std::string& gui2::tdrop_down_list::window_id ( ) const
privatevirtual

Inherited from tdialog, implemented by REGISTER_DIALOG.

Implements gui2::tdialog.

Member Data Documentation

SDL_Rect gui2::tdrop_down_list::button_pos_
private

The screen location of the combobox button that triggred this droplist.

Note: we don't adjust the location of this dialog to when resizing the window. Instead this dialog automatically closes itself on resizing.

Definition at line 38 of file drop_down_list.hpp.

Referenced by pre_show().

std::vector<std::string> gui2::tdrop_down_list::items_
private

Definition at line 39 of file drop_down_list.hpp.

Referenced by pre_show().

int gui2::tdrop_down_list::selected_item_
private

Definition at line 40 of file drop_down_list.hpp.

Referenced by item_change_callback(), pre_show(), and selected_item().

bool gui2::tdrop_down_list::use_markup_
private

Definition at line 41 of file drop_down_list.hpp.

Referenced by pre_show().


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