The Battle for Wesnoth  1.15.1+dev
Public Member Functions | List of all members
editor::common_palette Class Referenceabstract

#include <common_palette.hpp>

Inheritance diagram for editor::common_palette:
Inheritance graph

Public Member Functions

 common_palette (CVideo &video)
 
virtual ~common_palette ()
 
virtual sdl_handler_vector handler_members ()
 
virtual bool scroll_up ()=0
 Scroll the editor-palette up one step if possible. More...
 
virtual bool can_scroll_up ()=0
 
virtual bool scroll_down ()=0
 Scroll the editor-palette down one step if possible. More...
 
virtual bool can_scroll_down ()=0
 
virtual void adjust_size (const SDL_Rect &target)=0
 
virtual void draw ()=0
 
virtual void set_group (std::size_t index)=0
 
virtual void next_group ()=0
 
virtual void prev_group ()=0
 
virtual const std::vector< item_group > & get_groups () const =0
 
virtual void expand_palette_groups_menu (std::vector< config > &items, int i)=0
 Menu expanding for palette group list. More...
 
virtual int num_items ()=0
 
virtual std::size_t start_num ()=0
 
virtual void set_start_item (std::size_t index)=0
 
virtual bool supports_swap ()
 
virtual void swap ()=0
 
virtual std::vector< std::string > action_pressed () const
 
- 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
 

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 draw_contents ()
 
virtual void update_location (const SDL_Rect &rect)
 
const SDL_Rect * clip_rect () const
 
virtual sdl_handler_vector member_handlers ()
 
virtual void handle_event (const SDL_Event &)
 
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 ()
 
- Protected Attributes inherited from gui::widget
bool focus_
 

Detailed Description

Definition at line 45 of file common_palette.hpp.

Constructor & Destructor Documentation

◆ common_palette()

editor::common_palette::common_palette ( CVideo video)
inline

Definition at line 49 of file common_palette.hpp.

◆ ~common_palette()

virtual editor::common_palette::~common_palette ( )
inlinevirtual

Definition at line 51 of file common_palette.hpp.

Member Function Documentation

◆ action_pressed()

virtual std::vector<std::string> editor::common_palette::action_pressed ( ) const
inlinevirtual

Reimplemented in editor::location_palette.

Definition at line 87 of file common_palette.hpp.

◆ adjust_size()

virtual void editor::common_palette::adjust_size ( const SDL_Rect &  target)
pure virtual

◆ can_scroll_down()

virtual bool editor::common_palette::can_scroll_down ( )
pure virtual

◆ can_scroll_up()

virtual bool editor::common_palette::can_scroll_up ( )
pure virtual

◆ draw()

virtual void editor::common_palette::draw ( )
pure virtual

◆ expand_palette_groups_menu()

virtual void editor::common_palette::expand_palette_groups_menu ( std::vector< config > &  items,
int  i 
)
pure virtual

◆ get_groups()

virtual const std::vector<item_group>& editor::common_palette::get_groups ( ) const
pure virtual

◆ handler_members()

virtual sdl_handler_vector editor::common_palette::handler_members ( )
inlinevirtual

◆ next_group()

virtual void editor::common_palette::next_group ( )
pure virtual

◆ num_items()

virtual int editor::common_palette::num_items ( )
pure virtual

◆ prev_group()

virtual void editor::common_palette::prev_group ( )
pure virtual

◆ scroll_down()

virtual bool editor::common_palette::scroll_down ( )
pure virtual

◆ scroll_up()

virtual bool editor::common_palette::scroll_up ( )
pure virtual

◆ set_group()

virtual void editor::common_palette::set_group ( std::size_t  index)
pure virtual

◆ set_start_item()

virtual void editor::common_palette::set_start_item ( std::size_t  index)
pure virtual

◆ start_num()

virtual std::size_t editor::common_palette::start_num ( )
pure virtual

◆ supports_swap()

virtual bool editor::common_palette::supports_swap ( )
inlinevirtual

Reimplemented in editor::empty_palette, and editor::unit_palette.

Definition at line 84 of file common_palette.hpp.

References swap().

◆ swap()

virtual void editor::common_palette::swap ( )
pure virtual

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