The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
gui2::generator_base Class Referenceabstract

Abstract base class for the generator. More...

#include <generator.hpp>

Inheritance diagram for gui2::generator_base:
Inheritance graph

Public Types

enum  placement { horizontal_list, vertical_list, table, independent }
 Determines how the items are placed. More...
 
typedef std::function< bool(unsigned,
unsigned)> 
order_func
 
- Public Types inherited from gui2::widget
enum  visibility { visibility::visible, visibility::hidden, visibility::invisible }
 Visibility settings done by the user. More...
 
enum  redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none }
 Visibility set by the engine. More...
 
- Public Types inherited from gui2::event::dispatcher
enum  event_queue_type { pre = 1, child = 2, post = 4 }
 
enum  queue_position {
  front_pre_child, back_pre_child, front_child, back_child,
  front_post_child, back_post_child
}
 The position where to add a new callback in the signal handler. More...
 
enum  mouse_behavior { all, hit, none }
 The behavior of the mouse events. More...
 

Public Member Functions

virtual ~generator_base ()
 
virtual void delete_item (const unsigned index)=0
 Deletes an item. More...
 
virtual void clear ()=0
 Deletes all items. More...
 
virtual void select_item (const unsigned index, const bool select)=0
 (De)selects an item. More...
 
void toggle_item (const unsigned index)
 Toggles the selection state of an item. More...
 
virtual bool is_selected (const unsigned index) const =0
 Returns whether the item is selected. More...
 
virtual void set_item_shown (const unsigned index, const bool show)=0
 Shows or hides an item. More...
 
virtual bool get_item_shown (const unsigned index) const =0
 Returns whether the item is shown. More...
 
boost::dynamic_bitset get_items_shown () const
 Returns the visibility of all the items as a bit set. More...
 
virtual unsigned get_item_count () const =0
 Returns the number of items. More...
 
virtual unsigned get_selected_item_count () const =0
 Returns the number of selected items. More...
 
virtual int get_selected_item () const =0
 Returns the selected item. More...
 
virtual griditem (const unsigned index)=0
 Gets the grid of an item. More...
 
virtual const griditem (const unsigned index) const =0
 Gets the grid of an item. More...
 
virtual gridcreate_item (const int index, builder_grid_const_ptr list_builder, const string_map &item_data, const std::function< void(widget &)> &callback)=0
 Creates a new item. More...
 
virtual gridcreate_item (const int index, builder_grid_const_ptr list_builder, const std::map< std::string, string_map > &data, const std::function< void(widget &)> &callback)=0
 Creates a new item. More...
 
virtual void create_items (const int index, builder_grid_const_ptr list_builder, const std::vector< string_map > &data, const std::function< void(widget &)> &callback)=0
 Creates one or more new item(s). More...
 
virtual void create_items (const int index, builder_grid_const_ptr list_builder, const std::vector< std::map< std::string, string_map > > &data, const std::function< void(widget &)> &callback)=0
 Creates one or more new item(s). More...
 
virtual void set_order (const order_func &order)=0
 
virtual void layout_initialize (const bool full_initialization) override=0
 See widget::layout_initialize. More...
 
virtual void request_reduce_width (const unsigned maximum_width) override=0
 See widget::request_reduce_width. More...
 
virtual void request_reduce_height (const unsigned maximum_height) override=0
 See widget::request_reduce_height. More...
 
virtual point calculate_best_size () const override=0
 See widget::calculate_best_size. More...
 
virtual void place (const point &origin, const point &size) override=0
 See widget::place. More...
 
virtual void set_origin (const point &origin) override=0
 See widget::set_origin. More...
 
virtual void set_visible_rectangle (const SDL_Rect &rectangle) override=0
 See widget::set_visible_rectangle. More...
 
virtual void impl_draw_children (surface &frame_buffer, int x_offset, int y_offset) override=0
 See widget::impl_draw_children. More...
 
virtual widgetfind_at (const point &coordinate, const bool must_be_active) override=0
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override=0
 See widget::find_at. More...
 
virtual void handle_key_up_arrow (SDL_Keymod modifier, bool &handled)=0
 Up arrow key pressed. More...
 
virtual void handle_key_down_arrow (SDL_Keymod modifier, bool &handled)=0
 Down arrow key pressed. More...
 
virtual void handle_key_left_arrow (SDL_Keymod modifier, bool &handled)=0
 Left arrow key pressed. More...
 
virtual void handle_key_right_arrow (SDL_Keymod modifier, bool &handled)=0
 Right arrow key pressed. More...
 
virtual unsigned get_ordered_index (unsigned index) const =0
 
virtual unsigned get_item_at_ordered (unsigned index_ordered) const =0
 
- Public Member Functions inherited from gui2::widget
 widget (const widget &)=delete
 
widgetoperator= (const widget &)=delete
 
 widget ()
 
 widget (const builder_widget &builder)
 Constructor. More...
 
virtual ~widget () override
 
void set_id (const std::string &id)
 
const std::string & id () const
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
dialogs::modal_dialogdialog ()
 Returns the top-level dialog. More...
 
void set_parent (widget *parent)
 
widgetparent ()
 
virtual void demand_reduce_width (const unsigned maximum_width)
 Tries to reduce the width of a widget. More...
 
virtual void demand_reduce_height (const unsigned maximum_height)
 Tries to reduce the height of a widget. More...
 
point get_best_size () const
 Gets the best size for the widget. More...
 
virtual bool can_mouse_focus () const
 Whether the mouse move/click event go 'through' this widget. More...
 
virtual bool can_wrap () const
 Can the widget wrap. More...
 
virtual void set_size (const point &size)
 Sets the size of the widget. More...
 
virtual void move (const int x_offset, const int y_offset)
 Moves a widget. More...
 
virtual void set_horizontal_alignment (const std::string &alignment)
 Sets the horizontal alignment of the widget within its parent grid. More...
 
virtual void set_vertical_alignment (const std::string &alignment)
 Sets the horizontal alignment of the widget within its parent grid. More...
 
virtual void layout_children ()
 Allows a widget to update its children. More...
 
point get_origin () const
 Returns the screen origin of the widget. More...
 
point get_size () const
 Returns the size of the widget. More...
 
SDL_Rect get_rectangle () const
 Gets the bounding rectangle of the widget on the screen. More...
 
int get_x () const
 
int get_y () const
 
unsigned get_width () const
 
unsigned get_height () const
 
void set_linked_group (const std::string &linked_group)
 
SDL_Rect calculate_blitting_rectangle (const int x_offset, const int y_offset)
 Calculates the blitting rectangle of the widget. More...
 
SDL_Rect calculate_clipping_rectangle (const int x_offset, const int y_offset)
 Calculates the clipping rectangle of the widget. More...
 
void draw_background (surface &frame_buffer, int x_offset, int y_offset)
 Draws the background of a widget. More...
 
void draw_children (surface &frame_buffer, int x_offset, int y_offset)
 Draws the children of a widget. More...
 
void draw_foreground (surface &frame_buffer, int x_offset, int y_offset)
 Draws the foreground of the widget. More...
 
void populate_dirty_list (window &caller, std::vector< widget * > &call_stack)
 Adds a widget to the dirty list if it is dirty. More...
 
SDL_Rect get_dirty_rectangle () const
 Gets the dirty rectangle of the widget. More...
 
void set_is_dirty (const bool is_dirty)
 
bool get_is_dirty () const
 
void set_visible (const visibility visible)
 
visibility get_visible () const
 
redraw_action get_drawing_action () const
 
void set_debug_border_mode (const unsigned debug_border_mode)
 
void set_debug_border_color (const color_t debug_border_color)
 
virtual widgetfind (const std::string &id, const bool must_be_active)
 Returns a widget with the wanted id. More...
 
virtual const widgetfind (const std::string &id, const bool must_be_active) const
 The constant version of find. More...
 
virtual bool has_widget (const widget &widget) const
 Does the widget contain the widget. More...
 
virtual bool disable_click_dismiss () const =0
 Does the widget disable easy close? More...
 
virtual iteration::walker_basecreate_walker ()=0
 Creates a new walker object on the heap. More...
 
- Public Member Functions inherited from gui2::event_executor
 event_executor ()
 
virtual ~event_executor ()
 
void set_wants_mouse_hover (const bool hover=true)
 
bool wants_mouse_hover () const
 
void set_wants_mouse_left_double_click (const bool click=true)
 
bool wants_mouse_left_double_click () const
 
void set_wants_mouse_middle_double_click (const bool click=true)
 
bool wants_mouse_middle_double_click () const
 
event_executorset_wants_mouse_right_double_click (const bool click=true)
 
bool wants_mouse_right_double_click () const
 
- Public Member Functions inherited from gui2::event::dispatcher
 dispatcher ()
 
virtual ~dispatcher ()
 
void connect ()
 Connects the dispatcher to the event handler. More...
 
bool has_event (const ui_event event, const event_queue_type event_type)
 
bool fire (const ui_event event, widget &target)
 Fires an event which has no extra parameters. More...
 
bool fire (const ui_event event, widget &target, const point &coordinate)
 Fires an event which takes a coordinate parameter. More...
 
bool fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const utf8::string &unicode)
 Fires an event which takes keyboard parameters. More...
 
bool fire (const ui_event event, widget &target, const point &pos, const point &distance)
 Fires an event which takes touch parameters. More...
 
bool fire (const ui_event event, widget &target, void *)
 Fires an event which takes notification parameters. More...
 
bool fire (const ui_event event, widget &target, message &msg)
 Fires an event which takes message parameters. More...
 
bool fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
 Fires an event that's a raw SDL event. More...
 
bool fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
 Fires an event which takes text input parameters. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event, E >::value > 
connect_signal (const signal_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event, E >::value > 
disconnect_signal (const signal_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
connect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
disconnect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
connect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
disconnect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
connect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
disconnect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
connect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
disconnect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
connect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
disconnect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
connect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
disconnect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
connect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_text_input. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
disconnect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_text_input. More...
 
void capture_mouse ()
 Captures the mouse. More...
 
void release_mouse ()
 Releases the mouse capture. More...
 
void set_mouse_behavior (const mouse_behavior mouse_behavior)
 
mouse_behavior get_mouse_behavior () const
 
void set_want_keyboard_input (const bool want_keyboard_input)
 
bool get_want_keyboard_input () const
 
void register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
 Registers a hotkey. More...
 
bool execute_hotkey (const hotkey::HOTKEY_COMMAND id)
 Executes a hotkey. More...
 

Static Public Member Functions

static generator_basebuild (const bool has_minimum, const bool has_maximum, const placement placement, const bool select)
 Create a new generator. More...
 

Protected Member Functions

virtual void child_populate_dirty_list (window &caller, const std::vector< widget * > &call_stack) override=0
 See widget::child_populate_dirty_list. More...
 
virtual void do_select_item (const unsigned index)=0
 Selects a not selected item. More...
 
virtual void do_deselect_item (const unsigned index)=0
 Deselects a selected item. More...
 
virtual griditem_ordered (const unsigned index)=0
 Gets the grid of an item. More...
 
virtual const griditem_ordered (const unsigned index) const =0
 Gets the grid of an item. More...
 
- Protected Member Functions inherited from gui2::widget
void set_layout_size (const point &size)
 
const pointlayout_size () const
 
void clear_layout_size ()
 Throws away layout_size_. More...
 

Friends

class debug_layout_graph
 

Detailed Description

Abstract base class for the generator.

A generator is a class which holds multiple grids and controls their placement on the screen. The final class is policy based, more info about the possible policies is documented in the build() function. This function is the factory to generate the classes as well.

Definition at line 40 of file generator.hpp.

Member Typedef Documentation

typedef std::function<bool (unsigned, unsigned)> gui2::generator_base::order_func

Definition at line 249 of file generator.hpp.

Member Enumeration Documentation

Determines how the items are placed.

Enumerator
horizontal_list 
vertical_list 
table 
independent 

Definition at line 50 of file generator.hpp.

Constructor & Destructor Documentation

virtual gui2::generator_base::~generator_base ( )
inlinevirtual

Definition at line 45 of file generator.hpp.

Member Function Documentation

generator_base * gui2::generator_base::build ( const bool  has_minimum,
const bool  has_maximum,
const placement  placement,
const bool  select 
)
static

Create a new generator.

Parameters
has_minimumDoes one item need to be selected.
has_maximumIs one the maximum number of items that can be selected?
placementThe placement of the grids, see tplacement for more info.
selectIf a grid is selected, what should happen? If true the grid is selected, if false the grid is shown.
Returns
A pointer to a new object. The caller gets ownership of the new object.

Definition at line 1166 of file generator.cpp.

References GENERATE_BODY.

virtual point gui2::generator_base::calculate_best_size ( ) const
overridepure virtual
virtual void gui2::generator_base::child_populate_dirty_list ( window caller,
const std::vector< widget * > &  call_stack 
)
overrideprotectedpure virtual
virtual void gui2::generator_base::clear ( )
pure virtual

Deletes all items.

Referenced by gui2::listbox::clear(), and gui2::multi_page::clear().

virtual grid& gui2::generator_base::create_item ( const int  index,
builder_grid_const_ptr  list_builder,
const string_map item_data,
const std::function< void(widget &)> &  callback 
)
pure virtual

Creates a new item.

The item_data is used for the first widget found, this normally should be used when there's one widget in an item.

Parameters
indexThe item before which to add the new item, 0 == begin, -1 == end.
list_builderA grid builder that's will build the contents of the new item.
item_dataThe data to initialize the parameters of the new item.
callbackThe callback function to call when an item in the grid is (de)selected.
Returns
A reference to the newly created grid.

Referenced by gui2::multi_page::add_page(), gui2::listbox::add_row(), and gui2::stacked_widget::finalize().

virtual grid& gui2::generator_base::create_item ( const int  index,
builder_grid_const_ptr  list_builder,
const std::map< std::string, string_map > &  data,
const std::function< void(widget &)> &  callback 
)
pure virtual

Creates a new item.

The item_data is used by id, and is meant to set multiple widgets in an item.

Parameters
indexThe item before which to add the new item, 0 == begin, -1 == end.
list_builderA grid builder that's will build the contents of the new item.
dataThe data to initialize the parameters of the new item.
callbackThe callback function to call when an item in the grid is (de)selected.
Returns
A reference to the newly created grid.
virtual void gui2::generator_base::create_items ( const int  index,
builder_grid_const_ptr  list_builder,
const std::vector< string_map > &  data,
const std::function< void(widget &)> &  callback 
)
pure virtual

Creates one or more new item(s).

For every item in item_data a new item is generated. This version expects one widget per item.

Parameters
indexThe item before which to add the new item, 0 == begin, -1 == end.
list_builderA grid builder that's will build the contents of the new item.
dataThe data to initialize the parameters of the new item.
callbackThe callback function to call when an item in the grid is (de)selected.

Referenced by gui2::multi_page::finalize(), and gui2::listbox::finalize().

virtual void gui2::generator_base::create_items ( const int  index,
builder_grid_const_ptr  list_builder,
const std::vector< std::map< std::string, string_map > > &  data,
const std::function< void(widget &)> &  callback 
)
pure virtual

Creates one or more new item(s).

For every item in item_data a new item is generated. This version expects multiple widgets per item.

Parameters
indexThe item before which to add the new item, 0 == begin, -1 == end.
list_builderA grid builder that's will build the contents of the new item.
dataThe data to initialize the parameters of the new item.
callbackThe callback function to call when an item in the grid is (de)selected.
virtual void gui2::generator_base::delete_item ( const unsigned  index)
pure virtual
virtual void gui2::generator_base::do_deselect_item ( const unsigned  index)
protectedpure virtual
virtual void gui2::generator_base::do_select_item ( const unsigned  index)
protectedpure virtual
virtual widget* gui2::generator_base::find_at ( const point coordinate,
const bool  must_be_active 
)
overridepure virtual
virtual const widget* gui2::generator_base::find_at ( const point coordinate,
const bool  must_be_active 
) const
overridepure virtual
virtual unsigned gui2::generator_base::get_item_at_ordered ( unsigned  index_ordered) const
pure virtual
virtual unsigned gui2::generator_base::get_item_count ( ) const
pure virtual

Returns the number of items.

Referenced by gui2::policy::placement::horizontal_list::calculate_best_size(), gui2::policy::placement::vertical_list::calculate_best_size(), gui2::policy::placement::table::calculate_best_size(), gui2::policy::placement::independent::calculate_best_size(), gui2::policy::minimum_selection::one_item::delete_item(), gui2::policy::placement::independent::find(), gui2::policy::placement::horizontal_list::find_at(), gui2::policy::placement::vertical_list::find_at(), gui2::policy::placement::table::find_at(), gui2::listbox::get_item_count(), get_items_shown(), gui2::stacked_widget::get_layer_count(), gui2::multi_page::get_page_count(), gui2::policy::placement::vertical_list::handle_key_down_arrow(), gui2::policy::placement::table::handle_key_down_arrow(), gui2::policy::placement::horizontal_list::handle_key_left_arrow(), gui2::policy::placement::table::handle_key_left_arrow(), gui2::policy::placement::horizontal_list::handle_key_right_arrow(), gui2::policy::placement::table::handle_key_right_arrow(), gui2::policy::placement::vertical_list::handle_key_up_arrow(), gui2::policy::placement::table::handle_key_up_arrow(), gui2::stacked_widget::layout_children(), gui2::listbox::list_item_clicked(), gui2::policy::placement::horizontal_list::place(), gui2::policy::placement::vertical_list::place(), gui2::policy::placement::table::place(), gui2::policy::placement::independent::place(), gui2::policy::placement::independent::request_reduce_height(), gui2::policy::placement::independent::request_reduce_width(), gui2::listbox::set_active_sorting_option(), gui2::policy::minimum_selection::one_item::set_item_shown(), gui2::policy::placement::horizontal_list::set_origin(), gui2::policy::placement::vertical_list::set_origin(), gui2::policy::placement::table::set_origin(), gui2::policy::placement::independent::set_origin(), gui2::policy::placement::horizontal_list::set_visible_rectangle(), gui2::policy::placement::vertical_list::set_visible_rectangle(), gui2::policy::placement::table::set_visible_rectangle(), and gui2::policy::placement::independent::set_visible_rectangle().

virtual bool gui2::generator_base::get_item_shown ( const unsigned  index) const
pure virtual
boost::dynamic_bitset gui2::generator_base::get_items_shown ( ) const
inline

Returns the visibility of all the items as a bit set.

Definition at line 120 of file generator.hpp.

References get_item_count(), get_item_shown(), and i.

Referenced by gui2::listbox::get_rows_shown(), and gui2::listbox::set_row_shown().

virtual unsigned gui2::generator_base::get_ordered_index ( unsigned  index) const
pure virtual
virtual int gui2::generator_base::get_selected_item ( ) const
pure virtual
virtual unsigned gui2::generator_base::get_selected_item_count ( ) const
pure virtual
virtual void gui2::generator_base::handle_key_down_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
pure virtual

Down arrow key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::vertical_list, and gui2::policy::placement::horizontal_list.

Referenced by gui2::listbox::handle_key_down_arrow().

virtual void gui2::generator_base::handle_key_left_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
pure virtual

Left arrow key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::vertical_list, and gui2::policy::placement::horizontal_list.

Referenced by gui2::listbox::handle_key_left_arrow().

virtual void gui2::generator_base::handle_key_right_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
pure virtual

Right arrow key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::vertical_list, and gui2::policy::placement::horizontal_list.

Referenced by gui2::listbox::handle_key_right_arrow().

virtual void gui2::generator_base::handle_key_up_arrow ( SDL_Keymod  modifier,
bool &  handled 
)
pure virtual

Up arrow key pressed.

Parameters
modifierThe SDL keyboard modifier when the key was pressed.
handledIf the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::vertical_list, and gui2::policy::placement::horizontal_list.

Referenced by gui2::listbox::handle_key_up_arrow().

virtual void gui2::generator_base::impl_draw_children ( surface frame_buffer,
int  x_offset,
int  y_offset 
)
overridepure virtual

See widget::impl_draw_children.

Reimplemented from gui2::widget.

virtual bool gui2::generator_base::is_selected ( const unsigned  index) const
pure virtual
virtual grid& gui2::generator_base::item ( const unsigned  index)
pure virtual

Gets the grid of an item.

Referenced by gui2::policy::placement::horizontal_list::calculate_best_size(), gui2::policy::placement::vertical_list::calculate_best_size(), gui2::policy::placement::table::calculate_best_size(), gui2::policy::placement::independent::calculate_best_size(), gui2::policy::placement::independent::find(), gui2::policy::placement::horizontal_list::find_at(), gui2::policy::placement::vertical_list::find_at(), gui2::policy::placement::table::find_at(), gui2::policy::placement::independent::find_at(), gui2::stacked_widget::get_layer_grid(), gui2::listbox::get_row_grid(), gui2::policy::placement::horizontal_list::handle_key_left_arrow(), gui2::policy::placement::table::handle_key_left_arrow(), gui2::policy::placement::horizontal_list::handle_key_right_arrow(), gui2::policy::placement::table::handle_key_right_arrow(), gui2::policy::select_action::show::init(), gui2::stacked_widget::layout_children(), gui2::listbox::layout_children(), gui2::listbox::list_item_clicked(), gui2::multi_page::page_grid(), gui2::listbox::place(), gui2::policy::placement::independent::place(), gui2::listbox::remove_row(), gui2::policy::placement::independent::request_reduce_height(), gui2::policy::placement::independent::request_reduce_width(), gui2::policy::placement::independent::set_origin(), gui2::listbox::set_row_active(), gui2::policy::placement::vertical_list::set_visible_rectangle(), gui2::policy::placement::table::set_visible_rectangle(), gui2::policy::placement::independent::set_visible_rectangle(), and gui2::listbox::update_visible_area_on_key_event().

virtual const grid& gui2::generator_base::item ( const unsigned  index) const
pure virtual

Gets the grid of an item.

virtual grid& gui2::generator_base::item_ordered ( const unsigned  index)
protectedpure virtual
virtual const grid& gui2::generator_base::item_ordered ( const unsigned  index) const
protectedpure virtual

Gets the grid of an item.

virtual void gui2::generator_base::layout_initialize ( const bool  full_initialization)
overridepure virtual

See widget::layout_initialize.

Reimplemented from gui2::widget.

virtual void gui2::generator_base::place ( const point origin,
const point size 
)
overridepure virtual
virtual void gui2::generator_base::request_reduce_height ( const unsigned  maximum_height)
overridepure virtual
virtual void gui2::generator_base::request_reduce_width ( const unsigned  maximum_width)
overridepure virtual
virtual void gui2::generator_base::select_item ( const unsigned  index,
const bool  select 
)
pure virtual
virtual void gui2::generator_base::set_item_shown ( const unsigned  index,
const bool  show 
)
pure virtual

Shows or hides an item.

The caller is responsible for reformatting the grid.

Parameters
indexThe item to show or hide.
showIf true shows the item, else hides it.

Implemented in gui2::policy::minimum_selection::no_item, and gui2::policy::minimum_selection::one_item.

Referenced by gui2::listbox::set_row_shown().

virtual void gui2::generator_base::set_order ( const order_func order)
pure virtual

Referenced by gui2::listbox::order_by().

virtual void gui2::generator_base::set_origin ( const point origin)
overridepure virtual
virtual void gui2::generator_base::set_visible_rectangle ( const SDL_Rect &  rectangle)
overridepure virtual
void gui2::generator_base::toggle_item ( const unsigned  index)
inline

Toggles the selection state of an item.

Parameters
indexThe item to toggle.

Definition at line 98 of file generator.hpp.

References is_selected(), and select_item().

Referenced by gui2::listbox::list_item_clicked().

Friends And Related Function Documentation

friend class debug_layout_graph
friend

Definition at line 42 of file generator.hpp.


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