The Battle for Wesnoth  1.19.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 (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 (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 rectlocation () 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 queue_redraw ()
 Indicate that the widget should be redrawn. More...
void queue_redraw (const rect &)
 Indicate that a specific region of the screen should be redrawn. More...
void set_dirty (bool dirty=true)
bool dirty () const
const std::string & id () const
void set_id (const std::string &id)
void set_tooltip_string (const std::string &str)
virtual void process_tooltip_string (int mousex, int mousey) override
virtual void layout () override
 Called by draw_manager to validate layout. More...
virtual bool expose (const rect &region) override
 Called by draw_manager when it believes a redraw is necessary. More...
virtual rect screen_location () override
 The current draw location of the display, on the screen. More...
- Public Member Functions inherited from events::sdl_handler
virtual void handle_window_event (const SDL_Event &)
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
- Public Member Functions inherited from gui2::top_level_drawable
virtual void update ()
 Update state and any parameters that may effect layout, or any of the later stages. More...
virtual void render ()
 Perform any internal rendering necessary to prepare the drawable. More...

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 (const bool auto_join=true)
virtual ~widget ()
virtual void update_location (const SDL_Rect &)
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 Member Functions inherited from gui2::top_level_drawable
 top_level_drawable ()
virtual ~top_level_drawable ()
 top_level_drawable (const top_level_drawable &)
top_level_drawableoperator= (const top_level_drawable &)
 top_level_drawable (top_level_drawable &&)
top_level_drawableoperator= (top_level_drawable &&)

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 136 of file location_palette.cpp.

Constructor & Destructor Documentation

◆ location_palette_button()

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

Member Function Documentation

◆ mouse_up()

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

Reimplemented from gui::button.

Definition at line 147 of file location_palette.cpp.

References callback_, e, gui::button::mouse_up(), and gui::button::pressed().

Member Data Documentation

◆ callback_

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

Definition at line 156 of file location_palette.cpp.

Referenced by mouse_up().

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