Empty palette. More...

#include <empty_palette.hpp>

Inheritance diagram for editor::empty_palette:

Public Member Functions
	empty_palette (display &gui)

virtual bool	mouse_click ()

virtual bool	scroll_up () override
	Scroll the editor-palette up one step if possible. More...

virtual bool	can_scroll_up () override

virtual bool	scroll_down () override
	Scroll the editor-palette down one step if possible. More...

virtual bool	can_scroll_down () override

virtual void	adjust_size (const SDL_Rect &) override

void	hide (bool) override

std::vector< gui::widget > *	get_widgets ()

virtual void	set_group (std::size_t) override

virtual void	next_group () override

virtual void	prev_group () override

virtual const std::vector< item_group > &	get_groups () const override

virtual void	expand_palette_groups_menu (std::vector< config > &items, int i) override
	Menu expanding for palette group list. More...

virtual std::size_t	num_items () override

virtual std::size_t	start_num () override

virtual void	set_start_item (std::size_t) override

virtual bool	supports_swap () override
	Whether the hotkey system should the enable GUI button connected to swap(). More...

virtual void	swap () override
	For tools which support fg and bg items, exchange the two items. More...

Public Member Functions inherited from editor::common_palette
	common_palette ()

virtual	~common_palette ()

virtual sdl_handler_vector	handler_members ()

virtual std::vector< std::string >	action_pressed () const

Public Member Functions inherited from gui::widget
const 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)

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_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_handler &	operator= (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
display &	gui_

Additional Inherited Members
Protected Member Functions inherited from gui::widget
	widget (const bool auto_join=true)

virtual	~widget ()

virtual void	draw_contents ()

virtual void	update_location (const SDL_Rect &)

virtual void	handle_event (const SDL_Event &) override

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_handler &	operator= (const sdl_handler &)

virtual	~sdl_handler ()

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_drawable &	operator= (const top_level_drawable &)

	top_level_drawable (top_level_drawable &&)

top_level_drawable &	operator= (top_level_drawable &&)

Protected Attributes inherited from gui::widget
bool	focus_

Detailed Description

Empty palette.

Definition at line 27 of file empty_palette.hpp.

Constructor & Destructor Documentation

◆ empty_palette()

editor::empty_palette::empty_palette ( display & gui )

inline

Definition at line 31 of file empty_palette.hpp.

Member Function Documentation

◆ adjust_size()

virtual void editor::empty_palette::adjust_size ( const SDL_Rect & )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 44 of file empty_palette.hpp.

◆ can_scroll_down()

virtual bool editor::empty_palette::can_scroll_down ( )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 41 of file empty_palette.hpp.

◆ can_scroll_up()

virtual bool editor::empty_palette::can_scroll_up ( )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 39 of file empty_palette.hpp.

◆ expand_palette_groups_menu()

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

inlineoverridevirtual

Menu expanding for palette group list.

Implements editor::common_palette.

Definition at line 66 of file empty_palette.hpp.

References i.

◆ get_groups()

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

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 63 of file empty_palette.hpp.

◆ get_widgets()

std::vector<gui::widget>* editor::empty_palette::get_widgets ( )

inline

Definition at line 57 of file empty_palette.hpp.

◆ hide()

void editor::empty_palette::hide ( bool )

inlineoverridevirtual

Reimplemented from gui::widget.

Definition at line 46 of file empty_palette.hpp.

References display::find_action_button(), display::find_menu_button(), and gui_.

◆ mouse_click()

virtual bool editor::empty_palette::mouse_click ( )

inlinevirtual

Definition at line 36 of file empty_palette.hpp.

◆ next_group()

virtual void editor::empty_palette::next_group ( )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 61 of file empty_palette.hpp.

◆ num_items()

virtual std::size_t editor::empty_palette::num_items ( )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 72 of file empty_palette.hpp.

◆ prev_group()

virtual void editor::empty_palette::prev_group ( )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 62 of file empty_palette.hpp.

◆ scroll_down()

virtual bool editor::empty_palette::scroll_down ( )

inlineoverridevirtual

Scroll the editor-palette down one step if possible.

Implements editor::common_palette.

Definition at line 40 of file empty_palette.hpp.

◆ scroll_up()

virtual bool editor::empty_palette::scroll_up ( )

inlineoverridevirtual

Scroll the editor-palette up one step if possible.

Implements editor::common_palette.

Definition at line 38 of file empty_palette.hpp.

◆ set_group()

virtual void editor::empty_palette::set_group ( std::size_t )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 60 of file empty_palette.hpp.

◆ set_start_item()

virtual void editor::empty_palette::set_start_item ( std::size_t )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 74 of file empty_palette.hpp.

◆ start_num()

virtual std::size_t editor::empty_palette::start_num ( void )

inlineoverridevirtual

Implements editor::common_palette.

Definition at line 73 of file empty_palette.hpp.

◆ supports_swap()

virtual bool editor::empty_palette::supports_swap ( )

inlineoverridevirtual

Whether the hotkey system should the enable GUI button connected to swap().

Reimplemented from editor::common_palette.

Definition at line 75 of file empty_palette.hpp.

◆ swap()

virtual void editor::empty_palette::swap ( )

inlineoverridevirtual

For tools which support fg and bg items, exchange the two items.

Typically, fg and bg mean that they're placed by left or right mouse clicks, respectively.

There's a mismatch between class structure and responsibilities here, as part of the UX isn't part of the palette. The tool decides what right-click does. Even for the scenery item tool, where right-click deletes an item, fg and bg provide a way to switch between two items.

Implements editor::common_palette.

Definition at line 76 of file empty_palette.hpp.

Member Data Documentation

◆ gui_

display& editor::empty_palette::gui_

private

Definition at line 79 of file empty_palette.hpp.

Referenced by hide().

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

editor/palette/empty_palette.hpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ empty_palette()

Member Function Documentation

◆ adjust_size()

◆ can_scroll_down()

◆ can_scroll_up()

◆ expand_palette_groups_menu()

◆ get_groups()

◆ get_widgets()

◆ hide()

◆ mouse_click()

◆ next_group()

◆ num_items()

◆ prev_group()

◆ scroll_down()

◆ scroll_up()

◆ set_group()

◆ set_start_item()

◆ start_num()

◆ supports_swap()

◆ swap()

Member Data Documentation

◆ gui_