dialogs::unit_preview_pane Class Reference

Show unit-stats in a side-pane to unit-list, recall-list, etc. More...

#include <dialogs.hpp>

Inheritance diagram for dialogs::unit_preview_pane:

Classes
struct	details

Public Types
enum	TYPE { SHOW_ALL, SHOW_BASIC }

Public Member Functions
	unit_preview_pane (const gui::filter_textbox *filter=nullptr, TYPE type=SHOW_ALL, bool left_side=true)
bool	show_above () const
bool	left_side () const
void	set_selection (int index)
sdl_handler_vector	handler_members ()
Public Member Functions inherited from gui::preview_pane
	preview_pane (CVideo &video)
virtual	~preview_pane ()
Public Member Functions inherited from gui::widget
SDL_Rect const &	location () const
virtual void	set_location (SDL_Rect const &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 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 ()

Protected Attributes
int	index_
gui::button	details_button_
Protected Attributes inherited from gui::widget
bool	focus_

Private Member Functions
virtual size_t	size () const =0
virtual const details	get_details () const =0
virtual void	process_event ()=0
void	draw_contents ()

Private Attributes
const gui::filter_textbox *	filter_
bool	weapons_
bool	left_

Additional Inherited Members
Protected Member Functions inherited from gui::widget
	widget (widget const &o)
	widget (CVideo &video, const bool auto_join=true)
virtual	~widget ()
void	bg_register (SDL_Rect const &rect)
void	bg_restore () const
void	bg_restore (SDL_Rect const &rect) const
void	bg_update ()
void	bg_cancel ()
CVideo &	video () const
virtual void	draw ()
virtual void	update_location (SDL_Rect const &rect)
const SDL_Rect *	clip_rect () const
virtual sdl_handler_vector	member_handlers ()
virtual void	handle_event (SDL_Event const &)
virtual void	handle_window_event (SDL_Event const &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)
virtual	~sdl_handler ()

Detailed Description

Show unit-stats in a side-pane to unit-list, recall-list, etc.

Definition at line 58 of file dialogs.hpp.

Member Enumeration Documentation

enum dialogs::unit_preview_pane::TYPE

Enumerator
SHOW_ALL
SHOW_BASIC

Definition at line 61 of file dialogs.hpp.

Constructor & Destructor Documentation

dialogs::unit_preview_pane::unit_preview_pane	(	const gui::filter_textbox *	filter = nullptr,
		TYPE	type = SHOW_ALL,
		bool	left_side = true
	)

Definition at line 629 of file dialogs.cpp.

References font::relative_size(), gui::widget::set_measurements(), and weapons_.

Member Function Documentation

void dialogs::unit_preview_pane::draw_contents ( )

privatevirtual

Reimplemented from gui::widget.

Definition at line 674 of file dialogs.cpp.

References _(), dialogs::unit_preview_pane::details::abilities, dialogs::unit_preview_pane::details::alignment, dialogs::unit_preview_pane::details::attacks, font::BOLD_TEXT, sdl::create_rect(), details_button_, font::draw_text(), dialogs::unit_preview_pane::details::experience, get_details(), image::get_image(), GPU_SetClip(), GPU_UnsetClip(), dialogs::unit_preview_pane::details::hitpoints, dialogs::unit_preview_pane::details::hp_color, dialogs::unit_preview_pane::details::image, left_, left_side(), dialogs::unit_preview_pane::details::level, gui::widget::location(), dialogs::unit_preview_pane::details::max_experience, dialogs::unit_preview_pane::details::max_hitpoints, dialogs::unit_preview_pane::details::movement_left, dialogs::unit_preview_pane::details::name, font::NORMAL_COLOR, dialogs::unit_preview_pane::details::overlays, font::race, dialogs::unit_preview_pane::details::race, utils::REMOVE_EMPTY, image::reverse_image(), scale_surface(), resources::screen, sdl_blit(), gui::widget::set_dirty(), gui::widget::set_location(), size(), font::SIZE_NORMAL, font::SIZE_SMALL, utils::split(), string_table, utils::STRIP_SPACES, font::text_area(), dialogs::unit_preview_pane::details::total_movement, dialogs::unit_preview_pane::details::traits, dialogs::unit_preview_pane::details::type_name, font::unit_type, gui::widget::video(), font::weapon, font::weapon_details, font::weapon_details_sep, font::weapon_numbers_sep, weapons_, and dialogs::unit_preview_pane::details::xp_color.

virtual const details dialogs::unit_preview_pane::get_details ( ) const

privatepure virtual

Implemented in dialogs::unit_types_preview_pane, and dialogs::units_list_preview_pane.

Referenced by draw_contents().

sdl_handler_vector dialogs::unit_preview_pane::handler_members ( )

virtual

Reimplemented from gui::preview_pane.

Definition at line 642 of file dialogs.cpp.

References details_button_, and h.

bool dialogs::unit_preview_pane::left_side ( ) const

virtual

Implements gui::preview_pane.

Definition at line 654 of file dialogs.cpp.

References left_.

Referenced by draw_contents().

virtual void dialogs::unit_preview_pane::process_event ( )

privatepure virtual

Reimplemented from events::sdl_handler.

Implemented in dialogs::unit_types_preview_pane, and dialogs::units_list_preview_pane.

void dialogs::unit_preview_pane::set_selection ( int  index )

virtual

Implements gui::preview_pane.

Definition at line 659 of file dialogs.cpp.

References details_button_, filter_, gui::filter_textbox::get_index(), index_, gui::widget::set_dirty(), and size().

Referenced by dialogs::show_unit_list().

bool dialogs::unit_preview_pane::show_above ( ) const

virtual

Reimplemented from gui::preview_pane.

Definition at line 649 of file dialogs.cpp.

References weapons_.

virtual size_t dialogs::unit_preview_pane::size ( ) const

privatepure virtual

Implemented in dialogs::unit_types_preview_pane, and dialogs::units_list_preview_pane.

Referenced by draw_contents(), and set_selection().

Member Data Documentation

gui::button dialogs::unit_preview_pane::details_button_

protected

Definition at line 93 of file dialogs.hpp.

Referenced by draw_contents(), handler_members(), dialogs::units_list_preview_pane::process_event(), dialogs::unit_types_preview_pane::process_event(), and set_selection().

const gui::filter_textbox* dialogs::unit_preview_pane::filter_

private

Definition at line 102 of file dialogs.hpp.

Referenced by set_selection().

int dialogs::unit_preview_pane::index_

protected

Definition at line 92 of file dialogs.hpp.

Referenced by dialogs::units_list_preview_pane::get_details(), dialogs::unit_types_preview_pane::get_details(), dialogs::units_list_preview_pane::process_event(), dialogs::unit_types_preview_pane::process_event(), and set_selection().

bool dialogs::unit_preview_pane::left_

private

Definition at line 104 of file dialogs.hpp.

Referenced by draw_contents(), and left_side().

bool dialogs::unit_preview_pane::weapons_

private

Definition at line 103 of file dialogs.hpp.

Referenced by draw_contents(), show_above(), and unit_preview_pane().

---

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

• dialogs.hpp
• dialogs.cpp