gui::widget Class Reference

#include <widget.hpp>

Inheritance diagram for gui::widget:

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

Protected Member Functions
	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	draw_contents ()
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 ()
virtual std::vector < sdl_handler * >	handler_members ()

Protected Attributes
bool	focus_

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

Private Member Functions
void	volatile_draw ()
void	volatile_undraw ()
void	hide_override (bool value=true)

Private Attributes
CVideo *	video_
std::vector< surface_restorer >	restorer_
SDL_Rect	rect_
bool	needs_restore_
enum gui::widget:: { ... }	state_
bool	hidden_override_
bool	enabled_
bool	clip_
SDL_Rect	clip_rect_
bool	volatile_
std::string	help_text_
std::string	tooltip_text_
int	help_string_
std::string	id_
bool	mouse_lock_local_

Static Private Attributes
static bool	mouse_lock_ = false

Friends
class	scrollpane
class	dialog

Detailed Description

Definition at line 25 of file widget.hpp.

Member Enumeration Documentation

anonymous enum

private

Enumerator
UNINIT
HIDDEN
DIRTY
DRAWN

Definition at line 111 of file widget.hpp.

Constructor & Destructor Documentation

gui::widget::widget ( widget const &  o )

protected

Definition at line 35 of file widget.cpp.

gui::widget::widget ( CVideo &  video, const bool  auto_join = true  )

protected

Definition at line 43 of file widget.cpp.

gui::widget::~widget ( )

protectedvirtual

Definition at line 50 of file widget.cpp.

References bg_cancel(), and free_mouse_lock().

Member Function Documentation

void gui::widget::aquire_mouse_lock ( )

protected

Definition at line 56 of file widget.cpp.

References mouse_lock_, and mouse_lock_local_.

Referenced by gui::combo_drag::handle_move().

void gui::widget::bg_cancel ( )

protected

Definition at line 77 of file widget.cpp.

References i, and restorer_.

Referenced by set_location(), gui::scrollarea::test_scrollbar(), and ~widget().

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

protected

Definition at line 109 of file widget.cpp.

References restorer_, and video().

Referenced by editor::palette_manager::adjust_size(), help::help_text_area::set_inner_location(), gui::textbox::set_inner_location(), mp::gamebrowser::set_inner_location(), gui::menu::set_inner_location(), and update_location().

void gui::widget::bg_restore ( ) const

protected

Definition at line 251 of file widget.cpp.

References clip_, clip_rect_, i, needs_restore_, rect_, restorer_, update_rect(), and video().

Referenced by gui::menu::clear_item(), draw(), mp::gamebrowser::draw(), gui::menu::draw(), mp::wait::leader_preview_pane::draw_contents(), gui::tristate_button::draw_contents(), help::help_text_area::draw_contents(), gui::menu::style::draw_row_bg(), hide(), hide_override(), editor::palette_manager::resrote_palete_bg(), set_location(), gui::scrollarea::test_scrollbar(), and volatile_undraw().

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

protected

Definition at line 267 of file widget.cpp.

References clip_, clip_rect_, i, restorer_, and video().

void gui::widget::bg_update ( )

protected

Definition at line 244 of file widget.cpp.

References i, and restorer_.

Referenced by hide(), hide_override(), and volatile_draw().

const SDL_Rect * gui::widget::clip_rect ( ) const

protected

Definition at line 104 of file widget.cpp.

References clip_, and clip_rect_.

Referenced by mp::gamebrowser::draw(), gui::menu::draw(), battle_prediction_pane::draw_unit(), battle_prediction_pane::get_hp_distrib_surface(), and gui::combo_drag::handle_move().

bool gui::widget::dirty

(

)

const

Definition at line 227 of file widget.cpp.

References DIRTY, and state_.

Referenced by draw(), mp::gamebrowser::draw(), and gui::menu::draw().

void gui::widget::draw ( )

protectedvirtual

Reimplemented from events::sdl_handler.

Reimplemented in gui::menu, mp::gamebrowser, location_palette_item, editor::editor_palette< Item >, editor::editor_palette< unit_type >, editor::editor_palette< overlay >, editor::editor_palette< t_translation::t_terrain >, gui::tristate_button, gui::scrollpane, editor::common_palette, editor::location_palette, and editor::empty_palette.

Definition at line 283 of file widget.cpp.

References bg_restore(), clip_, clip_rect_, dirty(), draw_contents(), hidden(), rect_, set_dirty(), update_rect(), and video().

Referenced by gui::tristate_button::draw(), location_palette_item::draw(), gui::dialog::draw_contents(), handle_event(), gui::textbox::handle_event(), editor::palette_manager::scroll_down(), editor::palette_manager::scroll_up(), and volatile_draw().

virtual void gui::widget::draw_contents ( )

inlineprotectedvirtual

Reimplemented in gui::menu, mp::ui, mp::gamebrowser, help::help_text_area, dialogs::unit_preview_pane, gui::scrollbar, gui::dialog_image, gui::tristate_button, editor::editor_palette< Item >, editor::editor_palette< unit_type >, editor::editor_palette< overlay >, editor::editor_palette< t_translation::t_terrain >, editor::palette_manager, gui::button, mp::wait::leader_preview_pane, gui::slider, gui::textbox, editor::location_palette, location_palette_item, battle_prediction_pane, gui::label, and gui::progress_bar.

Definition at line 86 of file widget.hpp.

Referenced by draw().

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

virtual

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

Definition at line 204 of file widget.cpp.

References enabled_, and set_dirty().

Referenced by gui::slider::enable(), gui::tristate_button::enable(), gui::button::enable(), mp::lobby::lobby(), mp::configure::process_event_impl(), mp::lobby::process_event_impl(), and mp::connect::side::side().

bool gui::widget::enabled

(

)

const

Definition at line 212 of file widget.cpp.

References enabled_.

Referenced by gui::textbox::draw_contents(), gui::slider::draw_contents(), gui::button::draw_contents(), gui::textbox::draw_cursor(), gui::slider::enable(), gui::tristate_button::enable(), gui::button::enable(), gui::label::get_color(), gui::slider::handle_event(), gui::button::handle_event(), gui::tristate_button::handle_event(), location_palette_item::handle_event(), gui::textbox::handle_event(), gui::slider::requires_event_focus(), gui::textbox::requires_event_focus(), and mp::configure::~configure().

bool gui::widget::focus

(

const SDL_Event *

event

)

Definition at line 157 of file widget.cpp.

References focus_, and events::has_focus().

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

void gui::widget::free_mouse_lock ( )

protected

Definition at line 63 of file widget.cpp.

References mouse_lock_, and mouse_lock_local_.

Referenced by gui::combo_drag::mouse_up(), and ~widget().

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

protectedvirtual

Implements events::sdl_handler.

Reimplemented in gui::menu, mp::ui, mp::gamebrowser, gui::textbox, gui::scrollbar, location_palette_item, gui::tristate_button, gui::multimenu, gui::file_menu, gui::button, editor::palette_manager, gui::slider, help::help_browser, and gui::scrollarea.

Definition at line 345 of file widget.cpp.

References draw(), DRAW_ALL_EVENT, and set_dirty().

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

void gui::widget::handle_window_event ( SDL_Event const &  event )

protectedvirtual

Implements events::sdl_handler.

Definition at line 352 of file widget.cpp.

References set_dirty().

int gui::widget::height

(

)

const

Definition at line 139 of file widget.cpp.

References rect_.

Referenced by gui::standard_dialog_button::action(), help::help_browser::adjust_layout(), gui::scrollbar::groove_area(), gui::menu::handle_event(), gui::scrollbar::is_valid_height(), dialogs::file_dialog::layout(), mp::options::entry_display::layout(), mp::options::slider_display::layout(), mp::options::checkbox_display::layout(), mp::options::combo_display::layout(), mp::options::title_display::layout(), mp::options::reset_display::layout(), gui::dialog::layout(), mp::wait::layout_children(), mp::create::layout_children(), mp::configure::layout_children(), mp::connect::layout_children(), mp::lobby::layout_children(), gui::menu::imgsel_style::load_images(), help::help_text_area::ref_at(), gui::menu::requires_event_focus(), help::help_text_area::set_items(), gui::scrollbar::update_location(), gui::menu::update_size(), and mp::ui::yscale().

bool gui::widget::hidden

(

)

const

Definition at line 198 of file widget.cpp.

References clip_, clip_rect_, HIDDEN, hidden_override_, rect_, sdl::rects_overlap(), state_, and UNINIT.

Referenced by draw(), mp::gamebrowser::draw(), gui::menu::draw(), gui::scrollarea::handle_event(), gui::slider::handle_event(), gui::button::handle_event(), gui::tristate_button::handle_event(), location_palette_item::handle_event(), gui::scrollbar::handle_event(), gui::textbox::handle_event(), gui::menu::handle_event(), process_help_string(), gui::menu::process_help_string(), process_tooltip_string(), gui::slider::requires_event_focus(), gui::textbox::requires_event_focus(), gui::menu::requires_event_focus(), gui::scrollarea::update_location(), and gui::scrollpane::update_widget_positions().

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

virtual

Reimplemented in editor::editor_palette< Item >, editor::editor_palette< unit_type >, editor::editor_palette< overlay >, editor::editor_palette< t_translation::t_terrain >, editor::location_palette, gui::scrollpane, editor::empty_palette, gui::scrollbar, and gui::scrollarea.

Definition at line 162 of file widget.cpp.

References bg_restore(), bg_update(), DIRTY, DRAWN, HIDDEN, hidden_override_, set_dirty(), and state_.

Referenced by mp::connect::connect(), editor::location_palette::draw_contents(), editor::editor_palette< Item >::draw_contents(), help::help_browser::help_browser(), gui::scrollarea::hide(), gui::scrollbar::hide(), editor::location_palette::hide(), mp::wait::hide_children(), mp::create::hide_children(), mp::configure::hide_children(), mp::options::entry_display::hide_children(), mp::options::slider_display::hide_children(), mp::options::checkbox_display::hide_children(), mp::options::combo_display::hide_children(), mp::connect::hide_children(), mp::options::title_display::hide_children(), mp::options::reset_display::hide_children(), mp::ui::hide_children(), mp::lobby::hide_children(), mp::create::init_level_changed(), mp::configure::layout_children(), location_palette_button::location_palette_button(), gui::combo_drag::mouse_up(), help::help_browser::process_event(), storyscreen::part_ui::render_story_box(), storyscreen::part_ui::render_title_box(), and mp::connect::side::side().

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

private

Definition at line 177 of file widget.cpp.

References bg_restore(), bg_update(), DIRTY, DRAWN, hidden_override_, set_dirty(), and state_.

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

(

)

const

Definition at line 232 of file widget.cpp.

References id_.

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

const SDL_Rect & gui::widget::location

(

)

const

Definition at line 144 of file widget.cpp.

References rect_.

Referenced by editor::location_palette::add_item(), help::help_browser::adjust_layout(), gui::button::calculate_size(), gui::scrollpane::client_area(), statistics_dialog::do_scene_selection(), mp::gamebrowser::draw(), gui::menu::draw(), gui::progress_bar::draw_contents(), gui::label::draw_contents(), location_palette_item::draw_contents(), editor::location_palette::draw_contents(), gui::slider::draw_contents(), mp::wait::leader_preview_pane::draw_contents(), gui::button::draw_contents(), editor::palette_manager::draw_contents(), gui::tristate_button::draw_contents(), gui::dialog_image::draw_contents(), dialogs::unit_preview_pane::draw_contents(), gui::textbox::draw_cursor(), battle_prediction_pane::draw_unit(), gui::scrollbar::groove_area(), gui::combo_drag::handle_move(), gui::scrollarea::has_scrollbar(), gui::tristate_button::hit(), gui::button::hit(), location_palette_item::hit(), gui::menu::hit_column(), gui::scrollarea::inner_location(), gui::dialog::layout(), mp::create::layout_children(), mp::configure::layout_children(), mp::connect::layout_children(), mp::lobby::layout_children(), gui::button::load_images(), gui::combo::make_drop_down_menu(), gui::slider::mouse_wheel(), gui::combo_drag::process(), gui::dialog::process(), help::help_browser::process_event(), help::help_text_area::ref_at(), gui::slider::set_slider_position(), gui::slider::slider_area(), gui::scrollarea::test_scrollbar(), gui::textbox::update_text_cache(), and gui::preview_pane::~preview_pane().

virtual sdl_handler_vector gui::widget::member_handlers ( )

inlineprotectedvirtual

Definition at line 90 of file widget.hpp.

bool gui::widget::mouse_locked ( ) const

protected

Definition at line 72 of file widget.cpp.

References mouse_lock_, and mouse_lock_local_.

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

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

virtual

Reimplemented from events::sdl_handler.

Reimplemented in gui::menu.

Definition at line 324 of file widget.cpp.

References CVideo::clear_help_string(), help_string_, help_text_, hidden(), sdl::point_in_rect(), rect_, CVideo::set_help_string(), and video().

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

virtual

Reimplemented from events::sdl_handler.

Definition at line 337 of file widget.cpp.

References tooltips::add_tooltip(), hidden(), sdl::point_in_rect(), rect_, and tooltip_text_.

void gui::widget::set_clip_rect

(

const SDL_Rect &

rect

)

Definition at line 191 of file widget.cpp.

References clip_, clip_rect_, and set_dirty().

Referenced by gui::scrollpane::add_widget().

void gui::widget::set_dirty

(

bool

dirty = true

)

Definition at line 217 of file widget.cpp.

References DIRTY, DRAWN, hidden_override_, needs_restore_, state_, and volatile_.

Referenced by help::help_browser::adjust_layout(), editor::palette_manager::adjust_size(), editor::location_palette::adjust_size(), gui::textbox::append_text(), gui::menu::change_item(), gui::textbox::clear(), gui::menu::do_sort(), draw(), mp::gamebrowser::draw(), gui::menu::draw(), editor::location_palette::draw_contents(), editor::palette_manager::draw_contents(), editor::editor_palette< Item >::draw_contents(), dialogs::unit_preview_pane::draw_contents(), enable(), gui::menu::erase_item(), gui::slider::handle_event(), gui::button::handle_event(), gui::tristate_button::handle_event(), location_palette_item::handle_event(), gui::scrollbar::handle_event(), handle_event(), gui::textbox::handle_event(), mp::gamebrowser::handle_event(), handle_window_event(), hide(), hide_override(), mp::wait::leader_preview_pane::process_event(), editor::palette_manager::resrote_palete_bg(), help::help_text_area::scroll(), gui::textbox::scroll(), mp::gamebrowser::scroll(), gui::menu::scroll(), editor::palette_manager::scroll_down(), editor::location_palette::scroll_down(), editor::palette_manager::scroll_up(), editor::unit_palette::select_bg_item(), mp::gamebrowser::select_game(), editor::location_palette::select_item(), gui::button::set_active(), gui::button::set_check(), set_clip_rect(), gui::label::set_color(), gui::textbox::set_cursor_pos(), set_focus(), gui::scrollbar::set_full_size(), mp::gamebrowser::set_game_items(), gui::menu::set_heading(), gui::button::set_image(), gui::menu::set_items(), gui::button::set_label(), set_location(), gui::slider::set_max(), gui::slider::set_min(), gui::button::set_overlay(), gui::scrollbar::set_position(), gui::tristate_button::set_pressed(), gui::progress_bar::set_progress_percent(), gui::textbox::set_selection(), mp::wait::leader_preview_pane::set_selection(), dialogs::unit_preview_pane::set_selection(), gui::scrollbar::set_shown_size(), gui::progress_bar::set_text(), gui::label::set_text(), gui::textbox::set_text(), gui::slider::set_value(), gui::textbox::set_wrap(), help::show_help(), help::help_text_area::show_topic(), gui::menu::sort_by(), gui::scrollpane::update_content_size(), gui::textbox::update_location(), gui::scrollpane::update_widget_positions(), and default_map_generator::user_config().

void gui::widget::set_focus

(

bool

focus

)

Definition at line 149 of file widget.cpp.

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

Referenced by editor::palette_manager::handle_event(), gui::textbox::handle_event(), mp::gamebrowser::handle_event(), gui::menu::handle_event(), gui::slider::mouse_down(), and gui::slider::mouse_wheel().

void gui::widget::set_height

(

int

h

)

Definition at line 124 of file widget.cpp.

References sdl::create_rect(), rect_, and set_location().

Referenced by help::help_browser::adjust_layout(), gui::button::calculate_size(), mp::configure::layout_children(), mp::ui::layout_children(), and help::show_help().

void gui::widget::set_help_string

(

const std::string &

str

)

Definition at line 314 of file widget.cpp.

References help_text_.

Referenced by gui::dialog::add_option(), mp::options::checkbox_display::checkbox_display(), mp::options::combo_display::combo_display(), mp::configure::configure(), mp::options::entry_display::entry_display(), mp::lobby::lobby(), and mp::options::slider_display::slider_display().

void gui::widget::set_id

(

const std::string &

id

)

Definition at line 237 of file widget.cpp.

References id(), and id_.

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

virtual

Reimplemented in mp::ui, gui::scrollpane, and gui::slider.

Definition at line 85 of file widget.cpp.

References bg_cancel(), bg_restore(), DRAWN, rect_, set_dirty(), 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::draw(), editor::location_palette::draw_contents(), editor::editor_palette< Item >::draw_contents(), dialogs::unit_preview_pane::draw_contents(), gui::combo_drag::handle_move(), mp::wait::layout_children(), mp::create::layout_children(), mp::configure::layout_children(), mp::connect::layout_children(), mp::ui::layout_children(), mp::lobby::layout_children(), mp::wait::leader_preview_pane::leader_preview_pane(), location_palette_button::location_palette_button(), gui::scrollpane::position_widget(), storyscreen::part_ui::prepare_geometry(), gui::combo_drag::process(), set_height(), set_location(), gui::slider::set_location(), gui::scrollpane::set_location(), set_measurements(), set_width(), about::show_about(), help::show_help(), gui::scrollarea::update_location(), gui::scrollbar::update_location(), gui::dialog::update_widget_positions(), and default_map_generator::user_config().

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

Definition at line 114 of file widget.cpp.

References sdl::create_rect(), rect_, and set_location().

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

Definition at line 129 of file widget.cpp.

References sdl::create_rect(), rect_, and set_location().

Referenced by battle_prediction_pane::battle_prediction_pane(), gui::dialog_image::dialog_image(), dialogs::file_dialog::file_dialog(), help::help_browser::help_browser(), mp::wait::layout_children(), mp::create::layout_children(), mp::ui::layout_children(), mp::lobby::layout_children(), mp::connect::side::side(), gui::textbox::textbox(), dialogs::unit_preview_pane::unit_preview_pane(), gui::label::update_label_size(), and gui::menu::update_size().

void gui::widget::set_tooltip_string

(

const std::string &

str

)

Definition at line 319 of file widget.cpp.

References tooltip_text_.

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

void gui::widget::set_volatile

(

bool

val = true

)

Definition at line 276 of file widget.cpp.

References DIRTY, DRAWN, state_, and volatile_.

void gui::widget::set_width

(

int

w

)

Definition at line 119 of file widget.cpp.

References sdl::create_rect(), rect_, and set_location().

Referenced by help::help_browser::adjust_layout(), gui::button::calculate_size(), mp::options::slider_display::layout(), mp::create::layout_children(), mp::configure::layout_children(), mp::ui::layout_children(), gui::scrollbar::scrollbar(), help::show_help(), and gui::dialog::update_widget_positions().

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

protectedvirtual

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

Definition at line 99 of file widget.cpp.

References bg_register().

Referenced by set_location(), and gui::scrollbar::update_location().

CVideo& gui::widget::video ( ) const

inlineprotected

Definition at line 83 of file widget.hpp.

References video_.

Referenced by editor::location_palette::adjust_size(), bg_register(), bg_restore(), draw(), mp::gamebrowser::draw(), gui::menu::draw(), gui::progress_bar::draw_contents(), gui::label::draw_contents(), location_palette_item::draw_contents(), gui::textbox::draw_contents(), gui::slider::draw_contents(), gui::button::draw_contents(), gui::tristate_button::draw_contents(), gui::dialog_image::draw_contents(), gui::scrollbar::draw_contents(), dialogs::unit_preview_pane::draw_contents(), help::help_text_area::draw_contents(), mp::gamebrowser::draw_contents(), gui::multimenu::draw_row(), gui::menu::imgsel_style::draw_row(), mp::gamebrowser::draw_row(), gui::menu::draw_row(), gui::menu::style::draw_row_bg(), gui::menu::imgsel_style::draw_row_bg(), battle_prediction_pane::draw_unit(), help::help_browser::handle_event(), gui::menu::max_items_onscreen(), dialogs::units_list_preview_pane::process_event(), dialogs::unit_types_preview_pane::process_event(), process_help_string(), and gui::menu::process_help_string().

void gui::widget::volatile_draw ( )

privatevirtual

Reimplemented from events::sdl_handler.

Definition at line 298 of file widget.cpp.

References bg_update(), DIRTY, draw(), DRAWN, hidden_override_, state_, and volatile_.

void gui::widget::volatile_undraw ( )

privatevirtual

Reimplemented from events::sdl_handler.

Definition at line 307 of file widget.cpp.

References bg_restore(), and volatile_.

int gui::widget::width

(

)

const

Definition at line 134 of file widget.cpp.

References rect_.

Referenced by help::help_browser::adjust_layout(), gui::file_menu::display_current_files(), dialogs::file_dialog::file_dialog(), help::help_text_area::get_y_for_floating_img(), gui::scrollarea::inner_location(), mp::options::entry_display::layout(), gui::dialog_frame::layout(), mp::options::combo_display::layout(), mp::options::reset_display::layout(), gui::dialog::layout(), mp::wait::layout_children(), mp::create::layout_children(), mp::configure::layout_children(), mp::connect::layout_children(), gui::menu::imgsel_style::load_images(), storyscreen::part_ui::prepare_geometry(), gui::scrollarea::scrollbar_width(), about::show_about(), gui::scrollarea::update_location(), gui::menu::update_size(), and mp::ui::xscale().

Friends And Related Function Documentation

friend class dialog

friend

Definition at line 128 of file widget.hpp.

friend class scrollpane

friend

Definition at line 127 of file widget.hpp.

Member Data Documentation

bool gui::widget::clip_

private

Definition at line 114 of file widget.hpp.

Referenced by bg_restore(), clip_rect(), draw(), hidden(), and set_clip_rect().

SDL_Rect gui::widget::clip_rect_

private

Definition at line 115 of file widget.hpp.

Referenced by bg_restore(), clip_rect(), draw(), hidden(), and set_clip_rect().

bool gui::widget::enabled_

private

Definition at line 113 of file widget.hpp.

Referenced by enable(), and enabled().

bool gui::widget::focus_

protected

Definition at line 94 of file widget.hpp.

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

int gui::widget::help_string_

private

Definition at line 121 of file widget.hpp.

Referenced by process_help_string().

std::string gui::widget::help_text_

private

Definition at line 119 of file widget.hpp.

Referenced by process_help_string(), and set_help_string().

bool gui::widget::hidden_override_

private

Definition at line 112 of file widget.hpp.

Referenced by hidden(), hide(), hide_override(), set_dirty(), and volatile_draw().

std::string gui::widget::id_

private

Definition at line 122 of file widget.hpp.

Referenced by id(), and set_id().

bool gui::widget::mouse_lock_ = false

staticprivate

Definition at line 125 of file widget.hpp.

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

bool gui::widget::mouse_lock_local_

private

Definition at line 124 of file widget.hpp.

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

bool gui::widget::needs_restore_

mutableprivate

Definition at line 109 of file widget.hpp.

Referenced by bg_restore(), and set_dirty().

SDL_Rect gui::widget::rect_

private

Definition at line 108 of file widget.hpp.

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

std::vector< surface_restorer > gui::widget::restorer_

private

Definition at line 107 of file widget.hpp.

Referenced by bg_cancel(), bg_register(), bg_restore(), and bg_update().

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

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

std::string gui::widget::tooltip_text_

private

Definition at line 120 of file widget.hpp.

Referenced by process_tooltip_string(), and set_tooltip_string().

CVideo* gui::widget::video_

private

Definition at line 106 of file widget.hpp.

Referenced by video().

bool gui::widget::volatile_

private

Definition at line 117 of file widget.hpp.

Referenced by set_dirty(), set_volatile(), volatile_draw(), and volatile_undraw().

---

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

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