The Battle for Wesnoth  1.17.10+dev
Classes | Public Member Functions | Private Attributes | List of all members
location_palette_item Class Reference
Inheritance diagram for location_palette_item:

Classes

struct  state_t
 

Public Member Functions

 location_palette_item (editor::location_palette *parent)
 
void draw_contents () override
 
bool hit (int x, int y) const
 
void mouse_up (const SDL_MouseButtonEvent &e)
 
void handle_event (const SDL_Event &e) override
 
void set_item_id (const std::string &id)
 
void set_selected (bool selected)
 
- 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
 
virtual void enable (bool new_val=true)
 
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_help_string (const std::string &str)
 
void set_tooltip_string (const std::string &str)
 
virtual void process_help_string (int mousex, int mousey) override
 
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...
 

Private Attributes

std::string id_
 
std::string desc_
 
state_t state_
 
editor::location_paletteparent_
 

Additional Inherited Members

- 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 inherited from gui::widget
bool focus_
 

Detailed Description

Definition at line 38 of file location_palette.cpp.

Constructor & Destructor Documentation

◆ location_palette_item()

location_palette_item::location_palette_item ( editor::location_palette parent)
inline

Definition at line 54 of file location_palette.cpp.

Member Function Documentation

◆ draw_contents()

void location_palette_item::draw_contents ( )
inlineoverridevirtual

◆ handle_event()

void location_palette_item::handle_event ( const SDL_Event &  e)
inlineoverridevirtual

◆ hit()

bool location_palette_item::hit ( int  x,
int  y 
) const
inline

Definition at line 72 of file location_palette.cpp.

References rect::contains(), and gui::widget::location().

Referenced by handle_event(), and mouse_up().

◆ mouse_up()

void location_palette_item::mouse_up ( const SDL_MouseButtonEvent &  e)
inline

Definition at line 77 of file location_palette.cpp.

References hit(), id_, parent_, and editor::location_palette::select_item().

Referenced by handle_event().

◆ set_item_id()

void location_palette_item::set_item_id ( const std::string &  id)
inline

◆ set_selected()

void location_palette_item::set_selected ( bool  selected)
inline

Member Data Documentation

◆ desc_

std::string location_palette_item::desc_
private

Definition at line 133 of file location_palette.cpp.

Referenced by draw_contents(), and set_item_id().

◆ id_

std::string location_palette_item::id_
private

Definition at line 132 of file location_palette.cpp.

Referenced by draw_contents(), mouse_up(), and set_item_id().

◆ parent_

editor::location_palette* location_palette_item::parent_
private

Definition at line 135 of file location_palette.cpp.

Referenced by mouse_up().

◆ state_

state_t location_palette_item::state_
private

Definition at line 134 of file location_palette.cpp.

Referenced by draw_contents(), handle_event(), and set_selected().


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