gui::widget Class Reference

#include <widget.hpp>

Inheritance diagram for gui::widget:

Public Member Functions
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)
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_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...

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

Protected Attributes
bool	focus_

Private Types
enum	{ UNINIT , HIDDEN , DIRTY , DRAWN }

Private Member Functions
void	draw ()

Private Attributes
rect	rect_
enum gui::widget:: { ... }	state_
bool	enabled_
bool	clip_
rect	clip_rect_
std::string	tooltip_text_
std::string	id_
bool	mouse_lock_local_

Static Private Attributes
static bool	mouse_lock_ = false

Friends
class	dialog

Detailed Description

Definition at line 27 of file widget.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
UNINIT
HIDDEN
DIRTY
DRAWN

Definition at line 101 of file widget.hpp.

Constructor & Destructor Documentation

widget()

gui::widget::widget ( const bool  auto_join = true )

protected

Definition at line 33 of file widget.cpp.

~widget()

gui::widget::~widget ( )

protectedvirtual

Definition at line 40 of file widget.cpp.

References free_mouse_lock(), hidden(), and queue_redraw().

Member Function Documentation

aquire_mouse_lock()

void gui::widget::aquire_mouse_lock ( )

protected

Definition at line 48 of file widget.cpp.

References mouse_lock_, and mouse_lock_local_.

dirty()

bool gui::widget::dirty

(

)

const

Definition at line 193 of file widget.cpp.

References DIRTY, and state_.

Referenced by editor::location_palette::layout(), editor::palette_manager::layout(), and set_dirty().

draw()

void gui::widget::draw ( )

private

Definition at line 230 of file widget.cpp.

References clip_, clip_rect_, draw_contents(), hidden(), draw::reduce_clip(), and set_dirty().

Referenced by expose().

draw_contents()

virtual void gui::widget::draw_contents ( )

inlineprotectedvirtual

Reimplemented in gui::textbox, gui::menu, gui::tristate_button, editor::palette_manager, editor::location_palette, location_palette_item, editor::editor_palette< Item >, editor::editor_palette< t_translation::terrain_code >, editor::editor_palette< const unit_type & >, editor::editor_palette< overlay >, gui::scrollbar, gui::button, and help::help_text_area.

Definition at line 87 of file widget.hpp.

Referenced by draw().

enable()

void gui::widget::enable ( bool  new_val = true )

virtual

Reimplemented in gui::tristate_button, and gui::button.

Definition at line 167 of file widget.cpp.

References enabled_, and queue_redraw().

Referenced by gui::button::enable(), and gui::tristate_button::enable().

enabled()

bool gui::widget::enabled

(

)

const

Definition at line 175 of file widget.cpp.

References enabled_.

Referenced by gui::button::draw_contents(), gui::textbox::draw_contents(), gui::textbox::draw_cursor(), gui::button::enable(), gui::tristate_button::enable(), location_palette_item::handle_event(), gui::button::handle_event(), gui::tristate_button::handle_event(), gui::textbox::handle_event(), and gui::textbox::requires_event_focus().

expose()

bool gui::widget::expose ( const rect &  region )

overridevirtual

Called by draw_manager when it believes a redraw is necessary.

Implements gui2::top_level_drawable.

Definition at line 220 of file widget.cpp.

References clip_, clip_rect_, draw(), hidden(), rect::overlaps(), and rect_.

focus()

bool gui::widget::focus

(

const SDL_Event *

event

)

Definition at line 136 of file widget.cpp.

References focus_, and events::has_focus().

Referenced by gui::textbox::draw_contents(), editor::palette_manager::handle_event(), gui::menu::handle_event(), gui::textbox::handle_event(), and set_focus().

free_mouse_lock()

void gui::widget::free_mouse_lock ( )

protected

Definition at line 55 of file widget.cpp.

References mouse_lock_, and mouse_lock_local_.

Referenced by ~widget().

handle_event()

virtual void gui::widget::handle_event ( const SDL_Event &  )

inlineoverrideprotectedvirtual

Implements events::sdl_handler.

Reimplemented in gui::textbox, gui::menu, gui::tristate_button, editor::palette_manager, gui::scrollbar, gui::scrollarea, gui::button, help::help_browser, and location_palette_item.

Definition at line 90 of file widget.hpp.

Referenced by location_palette_item::handle_event(), help::help_browser::handle_event(), gui::button::handle_event(), gui::scrollarea::handle_event(), gui::scrollbar::handle_event(), editor::palette_manager::handle_event(), gui::tristate_button::handle_event(), and gui::textbox::handle_event().

height()

int gui::widget::height

(

)

const

Definition at line 118 of file widget.cpp.

References rect_.

Referenced by help::help_browser::adjust_layout(), help::help_text_area::get_max_x(), help::help_text_area::get_min_x(), gui::scrollarea::handle_event(), gui::menu::handle_event(), help::help_text_area::ref_at(), gui::menu::requires_event_focus(), help::help_text_area::set_items(), and gui::menu::update_size().

hidden()

bool gui::widget::hidden

(

)

const

Definition at line 161 of file widget.cpp.

References clip_, clip_rect_, HIDDEN, rect::overlaps(), rect_, state_, and UNINIT.

Referenced by draw(), expose(), location_palette_item::handle_event(), help::help_browser::handle_event(), gui::button::handle_event(), gui::scrollarea::handle_event(), gui::scrollbar::handle_event(), gui::tristate_button::handle_event(), gui::menu::handle_event(), gui::textbox::handle_event(), editor::location_palette::hide(), process_tooltip_string(), gui::menu::requires_event_focus(), gui::textbox::requires_event_focus(), gui::scrollarea::update_location(), and ~widget().

hide()

void gui::widget::hide ( bool  value = true )

virtual

Reimplemented in editor::empty_palette, gui::scrollarea, editor::location_palette, editor::editor_palette< Item >, editor::editor_palette< t_translation::terrain_code >, editor::editor_palette< const unit_type & >, and editor::editor_palette< overlay >.

Definition at line 141 of file widget.cpp.

References DIRTY, DRAWN, HIDDEN, queue_redraw(), and state_.

Referenced by help::help_browser::handle_event(), help::help_browser::help_browser(), editor::location_palette::hide(), gui::scrollarea::hide(), editor::editor_palette< Item >::layout(), editor::location_palette::layout(), editor::palette_manager::layout(), location_palette_button::location_palette_button(), help::help_browser::process_event(), gui::scrollarea::scrollarea(), and gui::scrollarea::update_location().

id()

const std::string & gui::widget::id

(

)

const

Definition at line 198 of file widget.cpp.

References id_.

Referenced by editor::location_palette::add_item(), editor::location_palette::is_selected_item(), set_id(), location_palette_item::set_item_id(), and gui::tristate_button::set_item_id().

layout()

void gui::widget::layout ( )

overridevirtual

Called by draw_manager to validate layout.

Reimplemented from gui2::top_level_drawable.

Reimplemented in gui::textbox, editor::palette_manager, editor::location_palette, editor::editor_palette< Item >, editor::editor_palette< t_translation::terrain_code >, editor::editor_palette< const unit_type & >, and editor::editor_palette< overlay >.

Definition at line 88 of file widget.cpp.

location()

const rect & gui::widget::location

(

)

const

Definition at line 123 of file widget.cpp.

References rect_.

Referenced by help::help_browser::adjust_layout(), gui::button::calculate_size(), gui::button::draw_contents(), gui::scrollbar::draw_contents(), location_palette_item::draw_contents(), gui::tristate_button::draw_contents(), gui::textbox::draw_cursor(), gui::scrollbar::grip_area(), gui::scrollbar::handle_event(), editor::palette_manager::handle_event(), location_palette_item::hit(), gui::tristate_button::hit(), gui::button::hit(), gui::scrollarea::inner_location(), gui::button::load_images(), location_palette_button::location_palette_button(), help::help_browser::process_event(), queue_redraw(), help::help_text_area::ref_at(), screen_location(), gui::scrollarea::test_scrollbar(), and gui::textbox::update_text_cache().

mouse_locked()

bool gui::widget::mouse_locked ( ) const

protected

Definition at line 64 of file widget.cpp.

References mouse_lock_, and mouse_lock_local_.

Referenced by location_palette_item::handle_event(), gui::button::handle_event(), gui::scrollarea::handle_event(), gui::scrollbar::handle_event(), gui::tristate_button::handle_event(), gui::menu::handle_event(), and gui::textbox::handle_event().

process_tooltip_string()

void gui::widget::process_tooltip_string ( int  mousex, int  mousey  )

overridevirtual

Reimplemented from events::sdl_handler.

Definition at line 251 of file widget.cpp.

References tooltips::add_tooltip(), rect::contains(), hidden(), rect_, and tooltip_text_.

queue_redraw() [1/2]

void gui::widget::queue_redraw

(

)

Indicate that the widget should be redrawn.

Definition at line 215 of file widget.cpp.

References location().

Referenced by help::help_browser::adjust_layout(), gui::textbox::append_text(), gui::textbox::clear(), enable(), gui::button::handle_event(), gui::scrollbar::handle_event(), gui::textbox::handle_event(), hide(), gui::menu::invalidate_row(), help::help_text_area::scroll(), gui::menu::scroll(), gui::textbox::scroll(), gui::button::set_active(), gui::button::set_check(), set_clip_rect(), gui::textbox::set_cursor_pos(), set_dirty(), set_focus(), gui::scrollbar::set_full_size(), gui::button::set_image(), gui::menu::set_items(), gui::button::set_label(), set_location(), gui::button::set_overlay(), gui::scrollbar::set_position(), gui::textbox::set_selection(), gui::scrollbar::set_shown_size(), gui::textbox::set_text(), gui::textbox::set_wrap(), help::help_text_area::show_topic(), help::show_with_toplevel(), gui::textbox::update_location(), and ~widget().

queue_redraw() [2/2]

void gui::widget::queue_redraw

(

const rect &

r

)

Indicate that a specific region of the screen should be redrawn.

This is in absolute drawing coordinates, and is not clipped.

Definition at line 210 of file widget.cpp.

References draw_manager::invalidate_region().

screen_location()

virtual rect gui::widget::screen_location ( )

inlineoverridevirtual

The current draw location of the display, on the screen.

Implements gui2::top_level_drawable.

Definition at line 79 of file widget.hpp.

References location().

set_clip_rect()

void gui::widget::set_clip_rect

(

const SDL_Rect &

rect

)

Definition at line 154 of file widget.cpp.

References clip_, clip_rect_, queue_redraw(), and draw::rect().

set_dirty()

void gui::widget::set_dirty

(

bool

dirty = true

)

Definition at line 180 of file widget.cpp.

References dirty(), DIRTY, DRAWN, queue_redraw(), and state_.

Referenced by editor::palette_manager::adjust_size(), editor::location_palette::adjust_size(), draw(), location_palette_item::handle_event(), gui::tristate_button::handle_event(), editor::editor_palette< Item >::layout(), editor::location_palette::layout(), editor::palette_manager::layout(), editor::palette_manager::scroll_down(), editor::location_palette::scroll_down(), editor::palette_manager::scroll_top(), editor::palette_manager::scroll_up(), editor::location_palette::scroll_up(), editor::unit_palette::select_bg_item(), editor::location_palette::select_item(), and gui::tristate_button::set_pressed().

set_focus()

void gui::widget::set_focus

(

bool

focus

)

Definition at line 128 of file widget.cpp.

References focus(), focus_, events::focus_handler(), and queue_redraw().

Referenced by editor::palette_manager::handle_event(), gui::menu::handle_event(), and gui::textbox::handle_event().

set_height()

void gui::widget::set_height

(

int

h

)

Definition at line 103 of file widget.cpp.

References h, rect_, and set_location().

Referenced by help::help_browser::adjust_layout(), gui::button::calculate_size(), and help::show_with_toplevel().

set_id()

void gui::widget::set_id

(

const std::string &

id

)

Definition at line 203 of file widget.cpp.

References id(), and id_.

set_location() [1/2]

void gui::widget::set_location ( const SDL_Rect &  rect )

virtual

Definition at line 69 of file widget.cpp.

References DIRTY, DRAWN, queue_redraw(), draw::rect(), rect_, state_, UNINIT, and update_location().

Referenced by help::help_browser::adjust_layout(), editor::palette_manager::adjust_size(), editor::location_palette::adjust_size(), gui::button::calculate_size(), gui::dialog_frame::layout(), location_palette_button::location_palette_button(), set_height(), set_location(), set_measurements(), set_width(), help::show_with_toplevel(), and gui::scrollarea::update_location().

set_location() [2/2]

void gui::widget::set_location	(	int	x,
		int	y
	)

Definition at line 93 of file widget.cpp.

References rect_, and set_location().

set_measurements()

void gui::widget::set_measurements	(	int	w,
		int	h
	)

Definition at line 108 of file widget.cpp.

References h, rect_, set_location(), and w.

Referenced by help::help_browser::help_browser(), gui::textbox::textbox(), and gui::menu::update_size().

set_tooltip_string()

void gui::widget::set_tooltip_string

(

const std::string &

str

)

Definition at line 246 of file widget.cpp.

References tooltip_text_.

Referenced by editor::editor_palette< Item >::layout(), and editor::location_palette::layout().

set_width()

void gui::widget::set_width

(

int

w

)

Definition at line 98 of file widget.cpp.

References rect_, set_location(), and w.

Referenced by help::help_browser::adjust_layout(), gui::button::calculate_size(), gui::scrollbar::scrollbar(), and help::show_with_toplevel().

update_location()

virtual void gui::widget::update_location ( const SDL_Rect &  )

inlineprotectedvirtual

Reimplemented in gui::textbox, gui::scrollarea, and help::help_browser.

Definition at line 88 of file widget.hpp.

Referenced by set_location().

width()

int gui::widget::width

(

)

const

Definition at line 113 of file widget.cpp.

References rect_.

Referenced by help::help_text_area::add_img_item(), help::help_browser::adjust_layout(), help::help_text_area::get_y_for_floating_img(), gui::scrollarea::inner_location(), gui::dialog_frame::layout(), gui::scrollarea::scrollbar_width(), gui::textbox::textbox(), gui::scrollarea::update_location(), and gui::menu::update_size().

Friends And Related Function Documentation

dialog

friend class dialog

friend

Definition at line 112 of file widget.hpp.

Member Data Documentation

clip_

bool gui::widget::clip_

private

Definition at line 103 of file widget.hpp.

Referenced by draw(), expose(), hidden(), and set_clip_rect().

clip_rect_

rect gui::widget::clip_rect_

private

Definition at line 104 of file widget.hpp.

Referenced by draw(), expose(), hidden(), and set_clip_rect().

enabled_

bool gui::widget::enabled_

private

Definition at line 102 of file widget.hpp.

Referenced by enable(), and enabled().

focus_

bool gui::widget::focus_

protected

Definition at line 91 of file widget.hpp.

Referenced by focus(), gui::menu::requires_event_focus(), gui::textbox::requires_event_focus(), and set_focus().

id_

std::string gui::widget::id_

private

Definition at line 107 of file widget.hpp.

Referenced by id(), and set_id().

mouse_lock_

bool gui::widget::mouse_lock_ = false

staticprivate

Definition at line 110 of file widget.hpp.

Referenced by aquire_mouse_lock(), free_mouse_lock(), and mouse_locked().

mouse_lock_local_

bool gui::widget::mouse_lock_local_

private

Definition at line 109 of file widget.hpp.

Referenced by aquire_mouse_lock(), free_mouse_lock(), and mouse_locked().

rect_

rect gui::widget::rect_

private

Definition at line 99 of file widget.hpp.

Referenced by expose(), height(), hidden(), location(), process_tooltip_string(), set_height(), set_location(), set_measurements(), set_width(), and width().

enum { ... } gui::widget::state_

Referenced by dirty(), hidden(), hide(), set_dirty(), and set_location().

tooltip_text_

std::string gui::widget::tooltip_text_

private

Definition at line 106 of file widget.hpp.

Referenced by process_tooltip_string(), and set_tooltip_string().

---

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

• widgets/widget.hpp
• widgets/widget.cpp