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

Classes

struct  state_t
 

Public Member Functions

 location_palette_item (CVideo &video, 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)
 
void draw () override
 
- 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
 
virtual void enable (bool new_val=true)
 
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)
 
- 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
 

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

Detailed Description

Definition at line 37 of file location_palette.cpp.

Constructor & Destructor Documentation

◆ location_palette_item()

location_palette_item::location_palette_item ( CVideo video,
editor::location_palette parent 
)
inline

Definition at line 53 of file location_palette.cpp.

Member Function Documentation

◆ draw()

void location_palette_item::draw ( )
inlineoverridevirtual

Reimplemented from gui::widget.

Definition at line 129 of file location_palette.cpp.

References gui::widget::draw().

Referenced by editor::location_palette::draw_contents().

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

References gui::widget::location(), and sdl::point_in_rect().

Referenced by handle_event(), and mouse_up().

◆ mouse_up()

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

Definition at line 76 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 132 of file location_palette.cpp.

Referenced by draw_contents(), and set_item_id().

◆ id_

std::string location_palette_item::id_
private

Definition at line 131 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 134 of file location_palette.cpp.

Referenced by mouse_up().

◆ state_

state_t location_palette_item::state_
private

Definition at line 133 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: