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

#include <simple_item_selector.hpp>

Inheritance diagram for gui2::tsimple_item_selector:
Inheritance graph

Public Types

typedef std::vector< std::stringlist_type
 
typedef std::string item_type
 

Public Member Functions

 tsimple_item_selector (const std::string &title, const std::string &message, list_type const &items, bool title_uses_markup=false, bool message_uses_markup=false)
 
int selected_index () const
 Returns the selected item index after displaying. More...
 
void set_selected_index (int index)
 Sets the initially selected item index (-1 by default). More...
 
void set_ok_label (const std::string &s)
 Sets the caption for the OK button. More...
 
const std::stringok_label () const
 
void set_cancel_label (const std::string &s)
 Sets the caption for the Cancel button. More...
 
const std::stringcancel_label () const
 
void set_single_button (bool value)
 Sets whether the Cancel button should be hidden or not. More...
 
bool single_button () 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...
 

Private Attributes

int index_
 
bool single_button_
 
list_type items_
 
std::string ok_label_
 
std::string cancel_label_
 

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

Definition at line 25 of file simple_item_selector.hpp.

Member Typedef Documentation

Definition at line 29 of file simple_item_selector.hpp.

Definition at line 28 of file simple_item_selector.hpp.

Constructor & Destructor Documentation

gui2::tsimple_item_selector::tsimple_item_selector ( const std::string title,
const std::string message,
list_type const &  items,
bool  title_uses_markup = false,
bool  message_uses_markup = false 
)

Definition at line 66 of file simple_item_selector.cpp.

Member Function Documentation

const std::string& gui2::tsimple_item_selector::cancel_label ( ) const
inline

Definition at line 67 of file simple_item_selector.hpp.

References cancel_label_.

const std::string& gui2::tsimple_item_selector::ok_label ( ) const
inline

Definition at line 57 of file simple_item_selector.hpp.

References ok_label_.

void gui2::tsimple_item_selector::post_show ( twindow window)
privatevirtual

Inherited from tdialog.

Reimplemented from gui2::tdialog.

Definition at line 119 of file simple_item_selector.cpp.

References gui2::tdialog::get_retval(), gui2::tlistbox::get_selected_row(), index_, and gui2::twindow::OK.

void gui2::tsimple_item_selector::pre_show ( twindow window)
privatevirtual
int gui2::tsimple_item_selector::selected_index ( ) const
inline

Returns the selected item index after displaying.

Returns
-1 if the dialog was canceled.

Definition at line 41 of file simple_item_selector.hpp.

References index_.

Referenced by events::console_handler::do_choose_level(), wb::manager::options_dlg(), and turn_info::process_network_data().

void gui2::tsimple_item_selector::set_cancel_label ( const std::string s)
inline

Sets the caption for the Cancel button.

Definition at line 63 of file simple_item_selector.hpp.

References cancel_label_.

void gui2::tsimple_item_selector::set_ok_label ( const std::string s)
inline

Sets the caption for the OK button.

Definition at line 53 of file simple_item_selector.hpp.

References ok_label_.

void gui2::tsimple_item_selector::set_selected_index ( int  index)
inline

Sets the initially selected item index (-1 by default).

Definition at line 47 of file simple_item_selector.hpp.

References index_.

Referenced by events::console_handler::do_choose_level().

void gui2::tsimple_item_selector::set_single_button ( bool  value)
inline

Sets whether the Cancel button should be hidden or not.

Definition at line 73 of file simple_item_selector.hpp.

References single_button_.

Referenced by turn_info::process_network_data().

bool gui2::tsimple_item_selector::single_button ( ) const
inline

Definition at line 77 of file simple_item_selector.hpp.

References single_button_.

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

Inherited from tdialog, implemented by REGISTER_DIALOG.

Implements gui2::tdialog.

Member Data Documentation

std::string gui2::tsimple_item_selector::cancel_label_
private

Definition at line 88 of file simple_item_selector.hpp.

Referenced by cancel_label(), pre_show(), and set_cancel_label().

int gui2::tsimple_item_selector::index_
private

Definition at line 83 of file simple_item_selector.hpp.

Referenced by post_show(), pre_show(), selected_index(), and set_selected_index().

list_type gui2::tsimple_item_selector::items_
private

Definition at line 86 of file simple_item_selector.hpp.

Referenced by pre_show().

std::string gui2::tsimple_item_selector::ok_label_
private

Definition at line 88 of file simple_item_selector.hpp.

Referenced by ok_label(), pre_show(), and set_ok_label().

bool gui2::tsimple_item_selector::single_button_
private

Definition at line 85 of file simple_item_selector.hpp.

Referenced by pre_show(), set_single_button(), and single_button().


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