#include <widget.hpp>
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 (unsigned w) |
void | set_height (unsigned h) |
void | set_measurements (unsigned w, unsigned h) |
unsigned | width () const |
unsigned | 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) |
virtual void | process_help_string (int mousex, int mousey) |
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 handler_vector | member_handlers () |
virtual void | handle_event (SDL_Event const &) |
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_ |
int | help_string_ |
std::string | id_ |
Friends | |
class | scrollpane |
class | dialog |
Definition at line 30 of file widgets/widget.hpp.
anonymous enum [private] |
gui::widget::widget | ( | widget const & | o | ) | [protected] |
Definition at line 26 of file widgets/widget.cpp.
gui::widget::widget | ( | CVideo & | video, | |
const bool | auto_join = true | |||
) | [protected] |
Definition at line 34 of file widgets/widget.cpp.
gui::widget::~widget | ( | ) | [protected, virtual] |
const SDL_Rect & gui::widget::location | ( | ) | const |
Definition at line 117 of file widgets/widget.cpp.
References rect_.
Referenced by help::help_browser::adjust_layout(), gui::button::button(), gui::button::calculate_size(), gui::scrollpane::client_area(), mp::gamebrowser::draw(), gui::menu::draw(), map_editor::brush_bar::draw(), map_editor::terrain_palette::draw(), gui::slider::draw_contents(), gui::progress_bar::draw_contents(), mp::wait::leader_preview_pane::draw_contents(), gui::label::draw_contents(), dialogs::campaign_preview_pane::draw_contents(), dialogs::unit_preview_pane::draw_contents(), gui::dialog_image::draw_contents(), gui::button::draw_contents(), gui::textbox::draw_cursor(), draw_tip_of_day(), gui::scrollbar::groove_area(), gui::scrollarea::has_scrollbar(), gui::button::hit(), gui::menu::hit_column(), gui::scrollarea::inner_location(), gui::dialog::layout(), mp::lobby::layout_children(), mp::create::layout_children(), mp::connect::layout_children(), gui::dialog::process(), help::help_browser::process_event(), gui::combo::process_event(), help::help_text_area::ref_at(), gui::textbox::set_location(), gui::slider::set_slider_position(), show_intro_part_helper(), gui::show_title(), gui::slider::slider_area(), gui::scrollarea::test_scrollbar(), gui::textbox::update_text_cache(), and gui::preview_pane::~preview_pane().
void gui::widget::set_location | ( | SDL_Rect const & | rect | ) | [virtual] |
Reimplemented in mp::ui, gui::scrollpane, gui::slider, and gui::textbox.
Definition at line 54 of file widgets/widget.cpp.
References bg_cancel(), bg_restore(), DRAWN, rect_, set_dirty(), state_, UNINIT, and update_location().
Referenced by help::help_browser::adjust_layout(), map_editor::brush_bar::adjust_size(), map_editor::terrain_palette::adjust_size(), gui::button::calculate_size(), gui::dialog_frame::draw(), mp::wait::leader_preview_pane::draw_contents(), dialogs::unit_preview_pane::draw_contents(), draw_tip_of_day(), mp::wait::layout_children(), mp::ui::layout_children(), mp::lobby::layout_children(), mp::create::layout_children(), mp::connect::layout_children(), mp::wait::leader_preview_pane::leader_preview_pane(), gui::scrollpane::position_widget(), set_height(), set_location(), set_measurements(), set_width(), about::show_about(), help::show_help(), show_intro_part(), gui::show_title(), gui::scrollbar::update_location(), gui::scrollarea::update_location(), gui::dialog::update_widget_positions(), and default_map_generator::user_config().
void gui::widget::set_location | ( | int | x, | |
int | y | |||
) |
Reimplemented in gui::scrollpane, gui::slider, and gui::textbox.
Definition at line 83 of file widgets/widget.cpp.
References rect, rect_, and set_location().
void gui::widget::set_width | ( | unsigned | w | ) |
Definition at line 89 of file widgets/widget.cpp.
References rect, rect_, and set_location().
Referenced by help::help_browser::adjust_layout(), gui::button::calculate_size(), mp::ui::layout_children(), mp::create::layout_children(), gui::scrollbar::scrollbar(), help::show_help(), and gui::dialog::update_widget_positions().
void gui::widget::set_height | ( | unsigned | h | ) |
Definition at line 95 of file widgets/widget.cpp.
References rect, rect_, and set_location().
Referenced by help::help_browser::adjust_layout(), gui::button::calculate_size(), mp::ui::layout_children(), and help::show_help().
void gui::widget::set_measurements | ( | unsigned | w, | |
unsigned | h | |||
) |
Definition at line 101 of file widgets/widget.cpp.
References rect, rect_, and set_location().
Referenced by map_editor::brush_bar::adjust_size(), dialogs::campaign_preview_pane::campaign_preview_pane(), gui::dialog_image::dialog_image(), dialogs::file_dialog::file_dialog(), help::help_browser::help_browser(), mp::wait::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().
unsigned gui::widget::width | ( | ) | const |
Definition at line 107 of file widgets/widget.cpp.
References rect_.
Referenced by help::help_text_area::add_img_item(), mp::connect::side::add_widgets_to_scrollpane(), help::help_browser::adjust_layout(), gui::file_menu::display_current_files(), dialogs::file_dialog::file_dialog(), gui::scrollarea::inner_location(), gui::dialog_frame::layout(), gui::dialog::layout(), mp::wait::layout_children(), mp::create::layout_children(), mp::connect::layout_children(), dialogs::network_data_dialog(), gui::scrollarea::scrollbar_width(), about::show_about(), help::show_help(), gui::scrollarea::update_location(), gui::menu::update_size(), and mp::ui::xscale().
unsigned gui::widget::height | ( | ) | const |
Definition at line 112 of file widgets/widget.cpp.
References rect_.
Referenced by gui::standard_dialog_button::action(), mp::connect::side::add_widgets_to_scrollpane(), help::help_browser::adjust_layout(), mp::wait::leader_preview_pane::draw_contents(), gui::scrollbar::groove_area(), gui::menu::handle_event(), gui::menu::hit_heading(), gui::scrollbar::is_valid_height(), gui::dialog::layout(), mp::wait::layout_children(), mp::lobby::layout_children(), mp::create::layout_children(), mp::connect::layout_children(), dialogs::network_data_dialog(), help::help_text_area::ref_at(), gui::menu::requires_event_focus(), help::help_text_area::set_items(), help::show_help(), gui::scrollbar::update_location(), gui::menu::update_size(), and mp::ui::yscale().
bool gui::widget::focus | ( | const SDL_Event * | event | ) |
Definition at line 130 of file widgets/widget.cpp.
References focus_, and events::has_focus().
Referenced by gui::textbox::draw_contents(), gui::textbox::handle_event(), gui::slider::handle_event(), mp::gamebrowser::handle_event(), gui::menu::handle_event(), map_editor::brush_bar::handle_event(), map_editor::terrain_palette::handle_event(), and gui::textbox::process().
void gui::widget::set_focus | ( | bool | focus | ) |
Definition at line 122 of file widgets/widget.cpp.
References focus_, events::focus_handler(), and set_dirty().
Referenced by gui::textbox::handle_event(), mp::gamebrowser::handle_event(), gui::menu::handle_event(), map_editor::brush_bar::handle_event(), map_editor::terrain_palette::handle_event(), and gui::slider::mouse_down().
void gui::widget::hide | ( | bool | value = true |
) | [virtual] |
Reimplemented in gui::scrollarea, gui::scrollbar, and gui::scrollpane.
Definition at line 135 of file widgets/widget.cpp.
References bg_restore(), bg_update(), DIRTY, DRAWN, HIDDEN, hidden_override_, set_dirty(), and state_.
Referenced by help::help_browser::help_browser(), gui::scrollbar::hide(), gui::scrollarea::hide(), mp::connect::side::hide_ai_algorithm_combo(), mp::wait::hide_children(), mp::ui::hide_children(), mp::lobby::hide_children(), mp::create::hide_children(), mp::connect::hide_children(), mp::connect::load_game(), mp::create::process_event(), help::help_browser::process_event(), and mp::connect::side::side().
bool gui::widget::hidden | ( | ) | const |
Definition at line 171 of file widgets/widget.cpp.
References clip_, clip_rect_, HIDDEN, hidden_override_, rect_, rects_overlap(), state_, and UNINIT.
Referenced by draw(), mp::gamebrowser::draw(), gui::menu::draw(), gui::textbox::handle_event(), gui::slider::handle_event(), gui::scrollbar::handle_event(), gui::scrollarea::handle_event(), gui::menu::handle_event(), gui::button::handle_event(), hidden_symbol(), process_help_string(), gui::textbox::requires_event_focus(), gui::slider::requires_event_focus(), gui::menu::requires_event_focus(), mp::connect::side::update_ai_algorithm_combo(), gui::scrollarea::update_location(), and gui::scrollpane::update_widget_positions().
void gui::widget::enable | ( | bool | new_val = true |
) | [virtual] |
Reimplemented in gui::button, and gui::slider.
Definition at line 177 of file widgets/widget.cpp.
References enabled_, and set_dirty().
Referenced by gui::slider::enable(), gui::button::enable(), mp::create::process_event(), and mp::connect::side::side().
bool gui::widget::enabled | ( | ) | const |
Definition at line 185 of file widgets/widget.cpp.
References enabled_.
Referenced by display::create_buttons(), gui::slider::draw_contents(), gui::button::draw_contents(), gui::slider::enable(), gui::button::enable(), gui::label::get_colour(), gui::slider::handle_event(), gui::button::handle_event(), mp::connect::side::import_network_user(), gui::slider::requires_event_focus(), and mp::connect::side::reset().
void gui::widget::set_clip_rect | ( | const SDL_Rect & | rect | ) |
Definition at line 164 of file widgets/widget.cpp.
References clip_, clip_rect_, and set_dirty().
Referenced by gui::scrollpane::add_widget().
void gui::widget::set_volatile | ( | bool | val = true |
) |
Definition at line 253 of file widgets/widget.cpp.
References DIRTY, DRAWN, state_, and volatile_.
Referenced by about::show_about().
void gui::widget::set_dirty | ( | bool | dirty = true |
) |
Reimplemented in map_editor::terrain_palette.
Definition at line 190 of file widgets/widget.cpp.
References DIRTY, DRAWN, hidden_override_, needs_restore_, state_, and volatile_.
Referenced by help::help_browser::adjust_layout(), map_editor::brush_bar::adjust_size(), gui::textbox::append_text(), gui::menu::change_item(), gui::textbox::clear(), gui::menu::do_sort(), draw(), mp::gamebrowser::draw(), gui::menu::draw(), map_editor::brush_bar::draw(), draw_tip_of_day(), enable(), gui::menu::erase_item(), gui::textbox::handle_event(), gui::slider::handle_event(), gui::scrollbar::handle_event(), mp::gamebrowser::handle_event(), gui::button::handle_event(), hide(), hide_override(), map_editor::brush_bar::left_mouse_click(), gui::textbox::process(), mp::wait::leader_preview_pane::process_event(), gui::textbox::scroll(), mp::gamebrowser::scroll(), gui::menu::scroll(), help::help_text_area::scroll(), gui::button::set_check(), set_clip_rect(), gui::label::set_colour(), map_editor::terrain_palette::set_dirty(), set_focus(), gui::scrollbar::set_full_size(), mp::gamebrowser::set_game_items(), gui::menu::set_heading(), gui::menu::set_items(), gui::button::set_label(), set_location(), gui::slider::set_max(), gui::slider::set_min(), gui::scrollbar::set_position(), gui::progress_bar::set_progress_percent(), mp::wait::leader_preview_pane::set_selection(), dialogs::campaign_preview_pane::set_selection(), dialogs::unit_preview_pane::set_selection(), gui::scrollbar::set_shown_size(), gui::label::set_size(), gui::textbox::set_text(), gui::progress_bar::set_text(), gui::label::set_text(), gui::slider::set_value(), gui::textbox::set_wrap(), about::show_about(), help::show_help(), help::help_text_area::show_topic(), gui::menu::sort_by(), gui::scrollpane::update_content_size(), gui::scrollpane::update_widget_positions(), and default_map_generator::user_config().
bool gui::widget::dirty | ( | ) | const |
Definition at line 200 of file widgets/widget.cpp.
Referenced by draw(), mp::gamebrowser::draw(), gui::menu::draw(), map_editor::brush_bar::draw(), and map_editor::terrain_palette::draw().
const std::string & gui::widget::id | ( | ) | const |
void gui::widget::set_id | ( | const std::string & | id | ) |
void gui::widget::set_help_string | ( | const std::string & | str | ) |
Definition at line 293 of file widgets/widget.cpp.
References help_text_.
Referenced by mp::create::create(), mp::lobby::lobby(), and gui::show_title().
void gui::widget::process_help_string | ( | int | mousex, | |
int | mousey | |||
) | [virtual] |
Reimplemented from events::handler.
Reimplemented in gui::menu.
Definition at line 298 of file widgets/widget.cpp.
References CVideo::clear_help_string(), help_string_, help_text_, hidden(), point_in_rect(), rect_, CVideo::set_help_string(), and video().
void gui::widget::bg_register | ( | SDL_Rect const & | rect | ) | [protected] |
Definition at line 78 of file widgets/widget.cpp.
References restorer_, and video().
Referenced by map_editor::terrain_palette::adjust_size(), gui::textbox::set_inner_location(), mp::gamebrowser::set_inner_location(), gui::menu::set_inner_location(), help::help_text_area::set_inner_location(), and update_location().
void gui::widget::bg_restore | ( | ) | const [protected] |
Definition at line 224 of file widgets/widget.cpp.
References util::scoped_resource< T, ReleasePolicy >::assign(), clip_, clip_rect_, 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(), help::help_text_area::draw_contents(), gui::menu::style::draw_row_bg(), hide(), hide_override(), map_editor::terrain_palette::scroll_down(), map_editor::terrain_palette::scroll_top(), map_editor::terrain_palette::scroll_up(), set_location(), gui::scrollarea::test_scrollbar(), and volatile_undraw().
void gui::widget::bg_restore | ( | SDL_Rect const & | rect | ) | const [protected] |
Definition at line 242 of file widgets/widget.cpp.
References util::scoped_resource< T, ReleasePolicy >::assign(), clip_, clip_rect_, restorer_, and video().
void gui::widget::bg_update | ( | ) | [protected] |
Definition at line 217 of file widgets/widget.cpp.
References restorer_.
Referenced by hide(), hide_override(), and volatile_draw().
void gui::widget::bg_cancel | ( | ) | [protected] |
Definition at line 46 of file widgets/widget.cpp.
References restorer_.
Referenced by set_location(), gui::scrollarea::test_scrollbar(), and ~widget().
CVideo& gui::widget::video | ( | ) | const [inline, protected] |
Definition at line 86 of file widgets/widget.hpp.
References video_.
Referenced by bg_register(), bg_restore(), draw(), mp::gamebrowser::draw(), gui::menu::draw(), gui::textbox::draw_contents(), gui::slider::draw_contents(), gui::scrollbar::draw_contents(), gui::progress_bar::draw_contents(), mp::wait::leader_preview_pane::draw_contents(), mp::ui::draw_contents(), mp::gamebrowser::draw_contents(), gui::label::draw_contents(), help::help_text_area::draw_contents(), dialogs::campaign_preview_pane::draw_contents(), dialogs::unit_preview_pane::draw_contents(), gui::dialog_image::draw_contents(), gui::button::draw_contents(), mp::gamebrowser::draw_row(), gui::menu::imgsel_style::draw_row(), gui::menu::draw_row(), gui::menu::imgsel_style::draw_row_bg(), gui::menu::style::draw_row_bg(), mp::create::hide_children(), gui::menu::max_items_onscreen(), mp::create::process_event(), process_help_string(), and gui::menu::process_help_string().
void gui::widget::draw | ( | ) | [protected, virtual] |
Reimplemented from events::handler.
Reimplemented in mp::gamebrowser, map_editor::terrain_palette, map_editor::brush_bar, gui::menu, and gui::scrollpane.
Definition at line 260 of file widgets/widget.cpp.
References util::scoped_resource< T, ReleasePolicy >::assign(), bg_restore(), clip_, clip_rect_, dirty(), draw_contents(), hidden(), rect_, set_dirty(), update_rect(), and video().
Referenced by gui::dialog::draw_contents(), gui::textbox::handle_event(), gui::textbox::process(), and volatile_draw().
virtual void gui::widget::draw_contents | ( | ) | [inline, protected, virtual] |
Reimplemented in gui::dialog_image, dialogs::unit_preview_pane, dialogs::campaign_preview_pane, help::help_text_area, mp::gamebrowser, mp::ui, mp::wait::leader_preview_pane, gui::button, gui::label, gui::menu, gui::progress_bar, gui::scrollbar, gui::slider, and gui::textbox.
Definition at line 89 of file widgets/widget.hpp.
Referenced by draw().
void gui::widget::update_location | ( | SDL_Rect const & | rect | ) | [protected, virtual] |
Reimplemented in help::help_browser, gui::scrollarea, and gui::scrollbar.
Definition at line 68 of file widgets/widget.cpp.
References bg_register().
Referenced by set_location(), and gui::scrollbar::update_location().
const SDL_Rect * gui::widget::clip_rect | ( | ) | const [protected] |
Definition at line 73 of file widgets/widget.cpp.
References clip_, and clip_rect_.
Referenced by mp::gamebrowser::draw(), and gui::menu::draw().
virtual handler_vector gui::widget::member_handlers | ( | ) | [inline, protected, virtual] |
Definition at line 93 of file widgets/widget.hpp.
virtual void gui::widget::handle_event | ( | SDL_Event const & | ) | [inline, protected, virtual] |
Implements events::handler.
Reimplemented in help::help_browser, mp::gamebrowser, mp::ui, map_editor::terrain_palette, map_editor::brush_bar, gui::button, gui::file_menu, gui::menu, gui::scrollarea, gui::scrollbar, gui::slider, and gui::textbox.
Definition at line 95 of file widgets/widget.hpp.
void gui::widget::volatile_draw | ( | ) | [private, virtual] |
Reimplemented from events::handler.
Definition at line 277 of file widgets/widget.cpp.
References bg_update(), DIRTY, draw(), DRAWN, hidden_override_, state_, and volatile_.
void gui::widget::volatile_undraw | ( | ) | [private, virtual] |
Reimplemented from events::handler.
Definition at line 286 of file widgets/widget.cpp.
References bg_restore(), and volatile_.
void gui::widget::hide_override | ( | bool | value = true |
) | [private] |
Definition at line 150 of file widgets/widget.cpp.
References bg_restore(), bg_update(), DIRTY, DRAWN, hidden_override_, set_dirty(), and state_.
friend class scrollpane [friend] |
Definition at line 121 of file widgets/widget.hpp.
friend class dialog [friend] |
Definition at line 122 of file widgets/widget.hpp.
bool gui::widget::focus_ [protected] |
Definition at line 96 of file widgets/widget.hpp.
Referenced by focus(), gui::textbox::requires_event_focus(), gui::slider::requires_event_focus(), gui::menu::requires_event_focus(), and set_focus().
CVideo* gui::widget::video_ [private] |
std::vector< surface_restorer > gui::widget::restorer_ [private] |
Reimplemented in help::help_menu.
Definition at line 105 of file widgets/widget.hpp.
Referenced by bg_cancel(), bg_register(), bg_restore(), and bg_update().
SDL_Rect gui::widget::rect_ [private] |
Reimplemented in help::help_menu.
Definition at line 106 of file widgets/widget.hpp.
Referenced by bg_restore(), draw(), height(), hidden(), location(), process_help_string(), set_height(), set_location(), set_measurements(), set_width(), and width().
bool gui::widget::needs_restore_ [mutable, private] |
enum { ... } gui::widget::state_ [private] |
Reimplemented in mp::connect, mp::wait, gui::button, gui::scrollbar, and gui::slider.
Referenced by dirty(), hidden(), hide(), hide_override(), set_dirty(), set_location(), set_volatile(), and volatile_draw().
bool gui::widget::hidden_override_ [private] |
Definition at line 110 of file widgets/widget.hpp.
Referenced by hidden(), hide(), hide_override(), set_dirty(), and volatile_draw().
bool gui::widget::enabled_ [private] |
bool gui::widget::clip_ [private] |
Definition at line 112 of file widgets/widget.hpp.
Referenced by bg_restore(), clip_rect(), draw(), hidden(), and set_clip_rect().
SDL_Rect gui::widget::clip_rect_ [private] |
Definition at line 113 of file widgets/widget.hpp.
Referenced by bg_restore(), clip_rect(), draw(), hidden(), and set_clip_rect().
bool gui::widget::volatile_ [private] |
Definition at line 115 of file widgets/widget.hpp.
Referenced by set_dirty(), set_volatile(), volatile_draw(), and volatile_undraw().
std::string gui::widget::help_text_ [private] |
Definition at line 117 of file widgets/widget.hpp.
Referenced by process_help_string(), and set_help_string().
int gui::widget::help_string_ [private] |
Reimplemented in gui::menu.
Definition at line 118 of file widgets/widget.hpp.
Referenced by process_help_string().
std::string gui::widget::id_ [private] |
Definition at line 119 of file widgets/widget.hpp.
Referenced by id(), help::has_id::operator()(), and set_id().
Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth | Gna! | Forum | Wiki | CIA | devdocs |