The Battle for Wesnoth  1.17.0-dev
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
location_palette_button Class Reference
Inheritance diagram for location_palette_button:

Public Member Functions

 location_palette_button (CVideo &video, const SDL_Rect &location, const std::string &text, const std::function< void(void)> &callback)
- Public Member Functions inherited from gui::button
TYPE get_type () const
 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="", int font_size=-1)
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
const SDL_Rect & location () const
virtual void set_location (const SDL_Rect &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::string & id () 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)
virtual void draw ()
- 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 ()
virtual bool has_joined ()
virtual bool has_joined_global ()
sdl_handleroperator= (sdl_handler &&)=delete
 Moving would require two instances' context membership to be handled, it's simpler to delete these and require the two instances to be separately constructed / destructed. More...
 sdl_handler (sdl_handler &&)=delete

Protected Member Functions

virtual void mouse_up (const SDL_MouseButtonEvent &e) override
- 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 draw_contents ()
- Protected Member Functions inherited from gui::widget
 widget (CVideo &video, const bool auto_join=true)
virtual ~widget ()
void bg_register (const SDL_Rect &rect)
void bg_restore () const
void bg_restore (const SDL_Rect &rect) const
void bg_update ()
void bg_cancel ()
CVideovideo () const
virtual void update_location (const SDL_Rect &rect)
const SDL_Rect * clip_rect () const
virtual sdl_handler_vector member_handlers ()
virtual void handle_window_event (const SDL_Event &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)
 sdl_handler (const sdl_handler &)
sdl_handleroperator= (const sdl_handler &)
virtual ~sdl_handler ()
virtual std::vector< sdl_handler * > handler_members ()

Protected Attributes

std::function< void(void)> callback_
- Protected Attributes inherited from gui::button
TYPE type_
- Protected Attributes inherited from gui::widget
bool focus_

Additional Inherited Members

- Public Types inherited from gui::button
enum  TYPE {

Detailed Description

Definition at line 138 of file location_palette.cpp.

Constructor & Destructor Documentation

◆ location_palette_button()

location_palette_button::location_palette_button ( CVideo video,
const SDL_Rect &  location,
const std::string &  text,
const std::function< void(void)> &  callback 

Definition at line 141 of file location_palette.cpp.

References gui::widget::hide(), and gui::widget::set_location().

Member Function Documentation

◆ mouse_up()

virtual void location_palette_button::mouse_up ( const SDL_MouseButtonEvent &  e)

Reimplemented from gui::button.

Definition at line 149 of file location_palette.cpp.

References gui::button::mouse_up().

Member Data Documentation

◆ callback_

std::function<void (void)> location_palette_button::callback_

Definition at line 158 of file location_palette.cpp.

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