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 | Protected Attributes | Private Attributes | List of all members
gui::dialog_button Class Reference

#include <construct_dialog.hpp>

Inheritance diagram for gui::dialog_button:
Inheritance graph

Public Member Functions

 dialog_button (CVideo &video, const std::string &label, TYPE type=TYPE_PRESS, int simple_result=CONTINUE_DIALOG, dialog_button_action *handler=nullptr)
 
void set_parent (class dialog *parent)
 
bool is_option () const
 
virtual int action (dialog_process_info &info)
 
- 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 void process_event ()
 
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

class dialogdialog () const
 
- 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 ()
 

Protected Attributes

const int simple_result_
 
- Protected Attributes inherited from gui::button
TYPE type_
 
- Protected Attributes inherited from gui::widget
bool focus_
 

Private Attributes

class dialogparent_
 
dialog_button_actionhandler_
 

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 }
 

Detailed Description

Definition at line 151 of file construct_dialog.hpp.

Constructor & Destructor Documentation

gui::dialog_button::dialog_button ( CVideo video,
const std::string label,
TYPE  type = TYPE_PRESS,
int  simple_result = CONTINUE_DIALOG,
dialog_button_action handler = nullptr 
)
inline

Definition at line 153 of file construct_dialog.hpp.

Member Function Documentation

int gui::dialog_button::action ( dialog_process_info info)
virtual
class dialog* gui::dialog_button::dialog ( ) const
inlineprotected

Definition at line 166 of file construct_dialog.hpp.

References parent_.

Referenced by gui::standard_dialog_button::action().

bool gui::dialog_button::is_option ( ) const
inline

Definition at line 161 of file construct_dialog.hpp.

References gui::button::type_, and gui::button::TYPE_CHECK.

void gui::dialog_button::set_parent ( class dialog parent)
inline

Definition at line 158 of file construct_dialog.hpp.

References parent_.

Referenced by gui::dialog::add_button().

Member Data Documentation

dialog_button_action* gui::dialog_button::handler_
private

Definition at line 170 of file construct_dialog.hpp.

Referenced by action().

class dialog* gui::dialog_button::parent_
private

Definition at line 169 of file construct_dialog.hpp.

Referenced by action(), dialog(), and set_parent().

const int gui::dialog_button::simple_result_
protected

Definition at line 167 of file construct_dialog.hpp.

Referenced by action(), and gui::standard_dialog_button::action().


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