Base class for creating containers with one or two scrollbar(s). More...

#include <scrollbar_container.hpp>

Inheritance diagram for gui2::tscrollbar_container:

Public Types
enum	tscrollbar_mode { always_visible, always_invisible, auto_visible, auto_visible_first_run }
	The way to handle the showing or hiding of the scrollbar. More...

Public Types inherited from gui2::event::tdispatcher
enum	tevent_type { pre = 1, child = 2, post = 4 }

enum	tposition { 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	tmouse_behavior { all, hit, none }
	The behavior of the mouse events. More...

Public Member Functions
	tscrollbar_container (const unsigned canvas_count)

	~tscrollbar_container ()

virtual void	layout_initialise (const bool full_initialisation) override
	See twidget::layout_initialise. More...

virtual void	request_reduce_height (const unsigned maximum_height) override
	See twidget::request_reduce_height. More...

virtual void	request_reduce_width (const unsigned maximum_width) override
	See twidget::request_reduce_width. More...

virtual bool	can_wrap () const override
	See twidget::can_wrap. More...

virtual void	place (const tpoint &origin, const tpoint &size) override
	See twidget::place. More...

virtual void	set_origin (const tpoint &origin) override
	See twidget::set_origin. More...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle) override
	See twidget::set_visible_rectangle. More...

virtual bool	get_active () const override
	See tcontrol::get_active. More...

virtual unsigned	get_state () const override
	See tcontrol::get_state. More...

virtual twidget *	find_at (const tpoint &coordinate, const bool must_be_active) override
	See twidget::find_at. More...

virtual const twidget *	find_at (const tpoint &coordinate, const bool must_be_active) const override
	See twidget::find_at. More...

twidget *	find (const std::string &id, const bool must_be_active) override
	See twidget::find. More...

const twidget *	find (const std::string &id, const bool must_be_active) const override
	See twidget::find. More...

bool	disable_click_dismiss () const override
	See twidget::disable_click_dismiss. More...

void	set_vertical_scrollbar_mode (const tscrollbar_mode scrollbar_mode)

tscrollbar_mode	get_vertical_scrollbar_mode () const

void	set_horizontal_scrollbar_mode (const tscrollbar_mode scrollbar_mode)

tscrollbar_mode	get_horizontal_scrollbar_mode () const

tgrid *	content_grid ()

const tgrid *	content_grid () const

const SDL_Rect &	content_visible_area () const

bool	vertical_scrollbar_at_end ()

unsigned	get_vertical_scrollbar_item_position () const
	Returns current position of the vertical scrollbar. More...

void	set_vertical_scrollbar_item_position (const unsigned position)
	Move the vertical scrollbar to a position. More...

void	scroll_vertical_scrollbar (const tscrollbar_::tscroll scroll)
	Scrolls the vertical scrollbar. More...

void	scroll_horizontal_scrollbar (const tscrollbar_::tscroll scroll)
	Scrolls the horizontal scrollbar. More...

void	vertical_scrollbar_moved ()
	Callback when the scrollbar moves (NOTE maybe only one callback needed). More...

void	horizontal_scrollbar_moved ()

Public Member Functions inherited from gui2::tcontainer_
	tcontainer_ (const unsigned canvas_count)

virtual SDL_Rect	get_client_rect () const
	Returns the client rect. More...

void	reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a container. More...

virtual void	demand_reduce_width (const unsigned maximum_width) override
	See twidget::demand_reduce_width. More...

void	reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a container. More...

virtual void	demand_reduce_height (const unsigned maximum_height) override
	See twidget::demand_reduce_height. More...

virtual bool	has_widget (const twidget &widget) const override
	See twidget::has_widget. More...

virtual void	set_active (const bool active) override
	See tcontrol::set_active. More...

virtual iterator::twalker_ *	create_walker () override
	See twidget::create_walker. More...

void	init_grid (const boost::intrusive_ptr< tbuilder_grid > &grid_builder)
	Initializes and builds the grid. More...

tgrid::iterator	begin ()

tgrid::iterator	end ()

unsigned	add_row (const unsigned count=1)

void	set_rows (const unsigned rows)

unsigned int	get_rows () const

void	set_cols (const unsigned cols)

unsigned int	get_cols () const

void	set_rows_cols (const unsigned rows, const unsigned cols)

void	set_child (twidget *widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)

void	set_row_grow_factor (const unsigned row, const unsigned factor)

void	set_column_grow_factor (const unsigned column, const unsigned factor)

const tgrid &	grid () const

tgrid &	grid ()

Public Member Functions inherited from gui2::tcontrol
	tcontrol (const unsigned canvas_count)

	tcontrol (const implementation::tbuilder_control &builder, const unsigned canvas_count, const std::string &control_type)
	Constructor. More...

virtual void	set_members (const string_map &data)
	Sets the members of the control. More...

tpoint	get_config_minimum_size () const
	Gets the minimum size as defined in the config. More...

tpoint	get_config_default_size () const
	Gets the default size as defined in the config. More...

tpoint	get_config_maximum_size () const
	Gets the best size as defined in the config. More...

virtual unsigned	get_characters_per_line () const
	Returns the number of characters per line. More...

virtual bool	get_link_aware () const
	Returns whether the label should be link_aware, in in rendering and in searching for links with get_link. More...

virtual std::string	get_link_color () const
	Returns the color string to be used with links. More...

void	set_definition (const std::string &definition)
	Sets the definition. More...

bool	get_use_tooltip_on_label_overflow () const

void	set_use_tooltip_on_label_overflow (const bool use_tooltip=true)

const t_string &	label () const

virtual void	set_label (const t_string &label)

virtual void	set_use_markup (bool use_markup)

bool	get_use_markup () const

const t_string &	tooltip () const

void	set_tooltip (const t_string &tooltip)

const t_string &	help_message () const

void	set_help_message (const t_string &help_message)

std::vector< tcanvas > &	canvas ()

tcanvas &	canvas (const unsigned index)

void	set_text_alignment (const PangoAlignment text_alignment)

PangoAlignment	get_text_alignment () const

Public Member Functions inherited from gui2::twidget
	twidget ()

	twidget (const tbuilder_widget &builder)
	Constructor. More...

virtual	~twidget () override

void	set_id (const std::string &id)

const std::string &	id () const

twindow *	get_window ()
	Get the parent window. More...

const twindow *	get_window () const
	The constant version of get_window. More...

tdialog *	dialog ()
	Returns the top-level dialogue. More...

void	set_parent (twidget *parent)

twidget *	parent ()

tpoint	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 void	set_size (const tpoint &size)
	Sets the size of the widget. More...

virtual void	move (const int x_offset, const int y_offset)
	Moves a widget. More...

tpoint	get_origin () const
	Returns the screen origin of the widget. More...

tpoint	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 (twindow &caller, std::vector< twidget * > &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 tvisible::scoped_enum visible)

tvisible::scoped_enum	get_visible () const

tredraw_action::scoped_enum	get_drawing_action () const

void	set_debug_border_mode (const unsigned debug_border_mode)

void	set_debug_border_colour (const unsigned debug_border_colour)

Public Member Functions inherited from gui2::tevent_executor
	tevent_executor ()

virtual	~tevent_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

tevent_executor &	set_wants_mouse_right_double_click (const bool click=true)

bool	wants_mouse_right_double_click () const

Public Member Functions inherited from gui2::event::tdispatcher
	tdispatcher ()

virtual	~tdispatcher ()

void	connect ()
	Connects the dispatcher to the event handler. More...

bool	has_event (const tevent event, const tevent_type event_type)

bool	fire (const tevent event, twidget &target)
	Fires an event which has no extra parameters. More...

bool	fire (const tevent event, twidget &target, const tpoint &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const tevent event, twidget &target, const SDLKey key, const SDLMod modifier, const utf8::string &unicode)
	Fires an event which takes keyboard parameters. More...

bool	fire (const tevent event, twidget &target, void *)
	Fires an event which takes notification parameters. More...

bool	fire (const tevent event, twidget &target, tmessage &message)
	Fires an event which takes message parameters. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event, boost::mpl::int_ < E > > >::type	connect_signal (const tsignal_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event, boost::mpl::int_ < E > > >::type	disconnect_signal (const tsignal_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_mouse, boost::mpl::int_< E > > >::type	connect_signal (const tsignal_mouse_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event_mouse. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_mouse, boost::mpl::int_< E > > >::type	disconnect_signal (const tsignal_mouse_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event_mouse. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_keyboard, boost::mpl::int_< E > > >::type	connect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event_keyboard. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_keyboard, boost::mpl::int_< E > > >::type	disconnect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event_keyboard. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_notification, boost::mpl::int_< E > > >::type	connect_signal (const tsignal_notification_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event_notification. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_notification, boost::mpl::int_< E > > >::type	disconnect_signal (const tsignal_notification_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event_notification. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_message, boost::mpl::int_< E > > >::type	connect_signal (const tsignal_message_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event_message. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_message, boost::mpl::int_< E > > >::type	disconnect_signal (const tsignal_message_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event_message. More...

void	capture_mouse ()
	Captures the mouse. More...

void	release_mouse ()
	Releases the mouse capture. More...

void	set_mouse_behavior (const tmouse_behavior mouse_behavior)

tmouse_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 thotkey_function &function)
	Registers a hotkey. More...

bool	execute_hotkey (const hotkey::HOTKEY_COMMAND id)
	Executes a hotkey. More...

Protected Member Functions
void	show_content_rect (const SDL_Rect &rect)
	Shows a certain part of the content. More...

void	set_scrollbar_button_status ()
	Sets the status of the scrollbar buttons. More...

bool	content_resize_request (const bool force_sizing=false)
	Notification if the content of a child needs a resize. More...

bool	content_resize_request (const int width_modification, const int height_modification, const int width_modification_pos=-1, const int height_modification_pos=-1)
	Request from the content to modify the size of the container. More...

virtual void	handle_key_home (SDLMod modifier, bool &handled)
	Home key pressed. More...

virtual void	handle_key_end (SDLMod modifier, bool &handled)
	End key pressed. More...

virtual void	handle_key_page_up (SDLMod modifier, bool &handled)
	Page up key pressed. More...

virtual void	handle_key_page_down (SDLMod modifier, bool &handled)
	Page down key pressed. More...

virtual void	handle_key_up_arrow (SDLMod modifier, bool &handled)
	Up arrow key pressed. More...

virtual void	handle_key_down_arrow (SDLMod modifier, bool &handled)
	Down arrow key pressed. More...

virtual void	handle_key_left_arrow (SDLMod modifier, bool &handled)
	Left arrow key pressed. More...

virtual void	handle_key_right_arrow (SDLMod modifier, bool &handled)
	Right arrow key pressed. More...

Protected Member Functions inherited from gui2::tcontrol
tresolution_definition_ptr	config ()

tresolution_definition_const_ptr	config () const

void	set_config (tresolution_definition_ptr config)

virtual void	update_canvas ()
	Updates the canvas(ses). More...

int	get_text_maximum_width () const
	Returns the maximum width available for the text. More...

int	get_text_maximum_height () const
	Returns the maximum height available for the text. More...

virtual void	impl_draw_background (surface &frame_buffer, int x_offset, int y_offset) override
	See twidget::impl_draw_background. More...

virtual void	impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) override
	See twidget::impl_draw_foreground. More...

std::string	get_label_token (const gui2::tpoint &position, const char *delimiters=" \n\r\t") const
	Exposes font::ttext::get_token, for the text label of this control. More...

std::string	get_label_link (const gui2::tpoint &position) const

Protected Member Functions inherited from gui2::twidget
void	set_layout_size (const tpoint &size)

const tpoint &	layout_size () const

Private Types
enum	tstate { ENABLED, DISABLED, COUNT }
	Possible states of the widget. More...

Private Member Functions
virtual tpoint	calculate_best_size () const override
	See twidget::calculate_best_size. More...

bool	content_resize_width (const int width_modification, const int width_modification_pos)
	Helper for content_resize_request. More...

bool	content_resize_height (const int height_modification, const int width_modification_pos)
	Helper for content_resize_request. More...

void	finalize_setup ()
	The builder needs to call us so we do our setup. More...

virtual void	finalize_subclass ()
	Function for the subclasses to do their setup. More...

virtual void	layout_children () override
	See twidget::layout_children. More...

virtual void	impl_draw_children (surface &frame_buffer, int x_offset, int y_offset) override
	See twidget::impl_draw_children. More...

virtual void	child_populate_dirty_list (twindow &caller, const std::vector< twidget * > &call_stack) override
	See twidget::child_populate_dirty_list. More...

virtual void	set_content_size (const tpoint &origin, const tpoint &size)
	Sets the size of the content grid. More...

void	scrollbar_moved ()
	Helper function which needs to be called after the scollbar moved. More...

virtual const std::string &	get_control_type () const override
	See tcontrol::get_control_type. More...

void	signal_handler_sdl_key_down (const event::tevent event, bool &handled, const SDLKey key, SDLMod modifier)

void	signal_handler_sdl_wheel_up (const event::tevent event, bool &handled)

void	signal_handler_sdl_wheel_down (const event::tevent event, bool &handled)

void	signal_handler_sdl_wheel_left (const event::tevent event, bool &handled)

void	signal_handler_sdl_wheel_right (const event::tevent event, bool &handled)

Private Attributes
tstate	state_
	Current state of the widget. More...

tscrollbar_mode	vertical_scrollbar_mode_
	The mode of how to show the scrollbar. More...

tscrollbar_mode	horizontal_scrollbar_mode_

tgrid *	vertical_scrollbar_grid_
	These are valid after finalize_setup(). More...

tgrid *	horizontal_scrollbar_grid_

tscrollbar_ *	vertical_scrollbar_
	These are valid after finalize_setup(). More...

tscrollbar_ *	horizontal_scrollbar_

tgrid *	content_grid_
	The grid that holds the content. More...

tspacer *	content_
	Dummy spacer to hold the contents location. More...

SDL_Rect	content_visible_area_
	Cache for the visible area for the content. More...

Friends
class	tdebug_layout_graph

struct	implementation::tbuilder_scroll_label

struct	implementation::tbuilder_scrollbar_panel

class	tlistbox

class	ttree_view

struct	tscrollbar_container_implementation

Detailed Description

Base class for creating containers with one or two scrollbar(s).

For now users can't instanciate this class directly and needs to use small wrapper classes. Maybe in the future users can use the class directly.

Todo:: events are not yet send to the content grid.

Definition at line 41 of file scrollbar_container.hpp.

Member Enumeration Documentation

enum gui2::tscrollbar_container::tscrollbar_mode

The way to handle the showing or hiding of the scrollbar.

Enumerator
always_visible	The scrollbar is always shown, whether needed or not.
always_invisible	The scrollbar is never shown even not when needed. There's also no space reserved for the scrollbar.
auto_visible	The scrollbar is shown when the number of items is larger as the visible items. The space for the scrollbar is always reserved, just in case it's needed after the initial sizing (due to adding items).
auto_visible_first_run	Like auto_visible, but when not needed upon the initial layout phase, the bars are not shown and no space is reserved for them. (The algorithm hides them by default.

Definition at line 62 of file scrollbar_container.hpp.

enum gui2::tscrollbar_container::tstate

private

Possible states of the widget.

Note the order of the states must be the same as defined in settings.hpp.

Enumerator
ENABLED
DISABLED
COUNT

Definition at line 442 of file scrollbar_container.hpp.

Constructor & Destructor Documentation

gui2::tscrollbar_container::tscrollbar_container ( const unsigned canvas_count )

explicit

Definition at line 68 of file scrollbar_container.cpp.

References gui2::event::tdispatcher::back_post_child, signal_handler_sdl_key_down(), signal_handler_sdl_wheel_down(), signal_handler_sdl_wheel_left(), signal_handler_sdl_wheel_right(), and signal_handler_sdl_wheel_up().

gui2::tscrollbar_container::~tscrollbar_container ( )

inline

Definition at line 56 of file scrollbar_container.hpp.

References content_grid_.

Member Function Documentation

tpoint gui2::tscrollbar_container::calculate_best_size ( ) const

overrideprivatevirtual

See twidget::calculate_best_size.

Reimplemented from gui2::tcontainer_.

Definition at line 305 of file scrollbar_container.cpp.

References content_grid_, DBG_GUI_L, gui2::twidget::get_best_size(), gui2::twidget::get_visible(), horizontal_scrollbar_grid_, gui2::twidget::tvisible::invisible, gui2::log_gui_layout, LOG_HEADER, log_scope2, LOG_SCOPE_HEADER, vertical_scrollbar_grid_, gui2::tpoint::x, and gui2::tpoint::y.

bool gui2::tscrollbar_container::can_wrap ( ) const

overridevirtual

See twidget::can_wrap.

Note: This function is called before the object is finalised.

Reimplemented from gui2::tcontainer_.

Reimplemented in gui2::tscroll_label.

Definition at line 300 of file scrollbar_container.cpp.

References gui2::tgrid::can_wrap(), and content_grid_.

void gui2::tscrollbar_container::child_populate_dirty_list	(	twindow &	caller,
		const std::vector< twidget * > &	call_stack
	)

overrideprivatevirtual

See twidget::child_populate_dirty_list.

Reimplemented from gui2::tcontainer_.

Reimplemented in gui2::tlistbox, and gui2::ttree_view.

Definition at line 846 of file scrollbar_container.cpp.

References gui2::tcontainer_::child_populate_dirty_list(), content_grid_, and gui2::twidget::populate_dirty_list().

Referenced by gui2::ttree_view::child_populate_dirty_list(), and gui2::tlistbox::child_populate_dirty_list().

tgrid* gui2::tscrollbar_container::content_grid ( )

inline

Definition at line 162 of file scrollbar_container.hpp.

References content_grid_.

Referenced by gui2::ttree_view_node::add_child(), gui2::implementation::tbuilder_scrollbar_panel::build(), gui2::tlistbox::finalize(), gui2::ttree_view::finalize_setup(), gui2::tscroll_label::finalize_subclass(), gui2::ttree_view::layout_children(), gui2::tlistbox::layout_children(), gui2::ttree_view::resize_content(), gui2::tlistbox::resize_content(), gui2::tscroll_label::set_can_wrap(), gui2::tlistbox::set_content_size(), gui2::tscroll_label::set_label(), and gui2::tscroll_label::set_use_markup().

const tgrid* gui2::tscrollbar_container::content_grid ( ) const

inline

Definition at line 166 of file scrollbar_container.hpp.

References content_grid_.

bool gui2::tscrollbar_container::content_resize_height	(	const int	height_modification,
		const int	width_modification_pos
	)

private

Helper for content_resize_request.

Handle the height modification.

Definition at line 691 of file scrollbar_container.cpp.

References gui2::adjust_scrollbar_mode(), always_invisible, auto_visible_first_run, content_, content_grid_, DBG_GUI_L, gui2::twidget::get_height(), gui2::twidget::get_visible(), gui2::twidget::get_window(), gui2::twindow::invalidate_layout(), gui2::twidget::tvisible::invisible, LOG_HEADER, vertical_scrollbar_, vertical_scrollbar_grid_, and vertical_scrollbar_mode_.

Referenced by content_resize_request().

bool gui2::tscrollbar_container::content_resize_request ( const bool force_sizing = false )

protected

Notification if the content of a child needs a resize.

When a resize is required the container first can try to handle it itself. If it can't honor the request the function will call twindow::invalidate_layout().

Note: Calling this function on a widget with size == (0, 0) results false but doesn't call invalidate_layout, the engine expects to be in build up phase with the layout already invalidated.

Parameters

force_sizing If the contents fit do we want to force a resize? This is needed in the MP lobby since items might not be properly placed yet. (The listboxes with the player info need it.)

Returns: True if the resize is handled, false otherwise.

Todo:: Try to handle auto_visible_first_run here as well.

Handling it here makes the code a bit more complex but allows to not reserve space for scrollbars, which will look nicer in the MP lobby. But the extra complexity is no 1.8 material.

Definition at line 528 of file scrollbar_container.cpp.

References always_invisible, auto_visible_first_run, content_, content_grid_, DBG_GUI_L, gui2::twidget::get_origin(), gui2::twidget::get_size(), gui2::twidget::get_visible(), gui2::twidget::get_window(), horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::twindow::invalidate_layout(), gui2::twidget::tvisible::invisible, LOG_HEADER, place(), gui2::tgrid::recalculate_best_size(), vertical_scrollbar_grid_, vertical_scrollbar_mode_, gui2::tpoint::x, and gui2::tpoint::y.

Referenced by gui2::ttree_view::resize_content(), gui2::tlistbox::resize_content(), gui2::tscroll_label::set_label(), gui2::tlistbox::set_row_shown(), and gui2::tlistbox::update_content_size().

bool gui2::tscrollbar_container::content_resize_request	(	const int	width_modification,
		const int	height_modification,
		const int	width_modification_pos = `-1`,
		const int	height_modification_pos = `-1`
	)

protected

Request from the content to modify the size of the container.

When the wanted resize fails the function will call twindow::invalidate_layout().

Note: Calling this function on a widget with size == (0, 0) results false but doesn't call invalidate_layout, the engine expects to be in build up phase with the layout already invalidated.; If twindow::get_need_layout() is true the function returns false and doesn't try to fit the contents since a layout phase will be triggered anyway.; This function might replace the content_resize_request above.

Parameters

width_modification	The wanted modification to the width: negative values reduce width. zero leave width as is. positive values increase width.
height_modification	The wanted modification to the height: negative values reduce height. zero leave height as is. positive values increase height.
width_modification_pos	The position where the additional content was inserted/removed, defaults to -1 whcih means 'at end'
height_modification_po	The position where the additional content was inserted/removed, defaults to -1 whcih means 'at end'

Returns: True is wanted modification is accepted false otherwise.

Definition at line 603 of file scrollbar_container.cpp.

References content_, content_grid_, content_resize_height(), content_resize_width(), DBG_GUI_L, gui2::twindow::get_need_layout(), gui2::twidget::get_size(), gui2::twidget::get_window(), LOG_HEADER, scrollbar_moved(), and set_scrollbar_button_status().

bool gui2::tscrollbar_container::content_resize_width	(	const int	width_modification,
		const int	width_modification_pos
	)

private

Helper for content_resize_request.

Handle the width modification.

Definition at line 642 of file scrollbar_container.cpp.

References gui2::adjust_scrollbar_mode(), always_invisible, auto_visible_first_run, content_, content_grid_, DBG_GUI_L, gui2::twidget::get_visible(), gui2::twidget::get_width(), gui2::twidget::get_window(), horizontal_scrollbar_, horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::twindow::invalidate_layout(), gui2::twidget::tvisible::invisible, and LOG_HEADER.

Referenced by content_resize_request().

const SDL_Rect& gui2::tscrollbar_container::content_visible_area ( ) const

inline

Definition at line 171 of file scrollbar_container.hpp.

References content_visible_area_.

Referenced by gui2::tlistbox::handle_key_down_arrow(), gui2::tlistbox::handle_key_left_arrow(), gui2::tlistbox::handle_key_right_arrow(), gui2::tlistbox::handle_key_up_arrow(), gui2::ttree_view::handle_up_down_arrow(), gui2::tlistbox::place(), gui2::tlistbox::set_row_shown(), and gui2::tlistbox::update_content_size().

bool gui2::tscrollbar_container::disable_click_dismiss ( ) const

overridevirtual

See twidget::disable_click_dismiss.

Reimplemented from gui2::tcontainer_.

Definition at line 521 of file scrollbar_container.cpp.

References content_grid_, gui2::tcontainer_::disable_click_dismiss(), and gui2::tgrid::disable_click_dismiss().

void gui2::tscrollbar_container::finalize_setup ( )

private

The builder needs to call us so we do our setup.

Definition at line 741 of file scrollbar_container.cpp.

References gui2::tclickable_::connect_click_handler(), gui2::event::connect_signal_notify_modified(), content_, content_grid_, finalize_subclass(), gui2::tcontainer_::grid(), horizontal_scrollbar_, horizontal_scrollbar_grid_, horizontal_scrollbar_moved(), scroll_horizontal_scrollbar(), scroll_vertical_scrollbar(), gui2::tcontrol::set_definition(), gui2::twidget::set_parent(), gui2::tgrid::swap_child(), vertical_scrollbar_, vertical_scrollbar_grid_, and vertical_scrollbar_moved().

Referenced by gui2::tlistbox::finalize(), and gui2::ttree_view::finalize_setup().

virtual void gui2::tscrollbar_container::finalize_subclass ( )

inlineprivatevirtual

Function for the subclasses to do their setup.

This function is called at the end of finalize_setup().

Reimplemented in gui2::tscroll_label.

Definition at line 491 of file scrollbar_container.hpp.

Referenced by finalize_setup().

twidget * gui2::tscrollbar_container::find	(	const std::string &	id,
		const bool	must_be_active
	)

overridevirtual

See twidget::find.

Reimplemented from gui2::tcontainer_.

Definition at line 507 of file scrollbar_container.cpp.

References gui2::twidget::id().

const twidget * gui2::tscrollbar_container::find	(	const std::string &	id,
		const bool	must_be_active
	)		const

overridevirtual

See twidget::find.

Reimplemented from gui2::tcontainer_.

Definition at line 514 of file scrollbar_container.cpp.

References gui2::twidget::id().

twidget * gui2::tscrollbar_container::find_at	(	const tpoint &	coordinate,
		const bool	must_be_active
	)

overridevirtual

See twidget::find_at.

Reimplemented from gui2::tcontainer_.

Definition at line 493 of file scrollbar_container.cpp.

const twidget * gui2::tscrollbar_container::find_at	(	const tpoint &	coordinate,
		const bool	must_be_active
	)		const

overridevirtual

See twidget::find_at.

Reimplemented from gui2::tcontainer_.

Definition at line 500 of file scrollbar_container.cpp.

bool gui2::tscrollbar_container::get_active ( ) const

overridevirtual

See tcontrol::get_active.

Implements gui2::tcontrol.

Reimplemented in gui2::tscroll_label, and gui2::tscrollbar_panel.

Definition at line 483 of file scrollbar_container.cpp.

References DISABLED, and state_.

const std::string & gui2::tscrollbar_container::get_control_type ( ) const

overrideprivatevirtual

See tcontrol::get_control_type.

Implements gui2::tcontrol.

Reimplemented in gui2::tlistbox, gui2::ttree_view, gui2::tscroll_label, and gui2::tscrollbar_panel.

Definition at line 1129 of file scrollbar_container.cpp.

tscrollbar_mode gui2::tscrollbar_container::get_horizontal_scrollbar_mode ( ) const

inline

Definition at line 157 of file scrollbar_container.hpp.

References horizontal_scrollbar_mode_.

unsigned gui2::tscrollbar_container::get_state ( ) const

overridevirtual

See tcontrol::get_state.

Implements gui2::tcontrol.

Reimplemented in gui2::tscroll_label, and gui2::tscrollbar_panel.

Definition at line 488 of file scrollbar_container.cpp.

References state_.

unsigned gui2::tscrollbar_container::get_vertical_scrollbar_item_position ( ) const

Returns current position of the vertical scrollbar.

Definition at line 979 of file scrollbar_container.cpp.

References gui2::tscrollbar_::get_item_position(), and vertical_scrollbar_.

Referenced by gui2::tlobby_main::append_to_chatbox().

tscrollbar_mode gui2::tscrollbar_container::get_vertical_scrollbar_mode ( ) const

inline

Definition at line 150 of file scrollbar_container.hpp.

References vertical_scrollbar_mode_.

void gui2::tscrollbar_container::handle_key_down_arrow	(	SDLMod	modifier,
		bool &	handled
	)

protectedvirtual

Down arrow key pressed.

Parameters

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

Reimplemented in gui2::tlistbox, and gui2::ttree_view.

Definition at line 1068 of file scrollbar_container.cpp.

References gui2::tscrollbar_::ITEM_FORWARD, gui2::tscrollbar_::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by gui2::ttree_view::handle_key_down_arrow(), and signal_handler_sdl_key_down().

void gui2::tscrollbar_container::handle_key_end	(	SDLMod	modifier,
		bool &	handled
	)

protectedvirtual

End key pressed.

Parameters

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

Definition at line 1024 of file scrollbar_container.cpp.

References gui2::tscrollbar_::END, gui2::tscrollbar_::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

void gui2::tscrollbar_container::handle_key_home	(	SDLMod	modifier,
		bool &	handled
	)

protectedvirtual

Home key pressed.

Parameters

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

Definition at line 1013 of file scrollbar_container.cpp.

References gui2::tscrollbar_::BEGIN, horizontal_scrollbar_, gui2::tscrollbar_::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

void gui2::tscrollbar_container::handle_key_left_arrow	(	SDLMod	modifier,
		bool &	handled
	)

protectedvirtual

Left arrow key pressed.

Parameters

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

Reimplemented in gui2::tlistbox, and gui2::ttree_view.

Definition at line 1079 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::tscrollbar_::ITEM_BACKWARDS, gui2::tscrollbar_::scroll(), and scrollbar_moved().

Referenced by gui2::ttree_view::handle_key_left_arrow(), gui2::tlistbox::handle_key_left_arrow(), gui2::tlistbox::handle_key_right_arrow(), and signal_handler_sdl_key_down().

void gui2::tscrollbar_container::handle_key_page_down	(	SDLMod	modifier,
		bool &	handled
	)

protectedvirtual

Page down key pressed.

Parameters

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

Definition at line 1045 of file scrollbar_container.cpp.

References gui2::tscrollbar_::JUMP_FORWARD, gui2::tscrollbar_::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

void gui2::tscrollbar_container::handle_key_page_up	(	SDLMod	modifier,
		bool &	handled
	)

protectedvirtual

Page up key pressed.

Parameters

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

Definition at line 1034 of file scrollbar_container.cpp.

References gui2::tscrollbar_::JUMP_BACKWARDS, gui2::tscrollbar_::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by signal_handler_sdl_key_down().

void gui2::tscrollbar_container::handle_key_right_arrow	(	SDLMod	modifier,
		bool &	handled
	)

protectedvirtual

Right arrow key pressed.

Parameters

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

Reimplemented in gui2::tlistbox, and gui2::ttree_view.

Definition at line 1090 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::tscrollbar_::ITEM_FORWARD, gui2::tscrollbar_::scroll(), and scrollbar_moved().

Referenced by gui2::ttree_view::handle_key_right_arrow(), and signal_handler_sdl_key_down().

void gui2::tscrollbar_container::handle_key_up_arrow	(	SDLMod	modifier,
		bool &	handled
	)

protectedvirtual

Up arrow key pressed.

Parameters

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

Reimplemented in gui2::tlistbox, and gui2::ttree_view.

Definition at line 1057 of file scrollbar_container.cpp.

References gui2::tscrollbar_::ITEM_BACKWARDS, gui2::tscrollbar_::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by gui2::tlistbox::handle_key_down_arrow(), gui2::ttree_view::handle_key_up_arrow(), gui2::tlistbox::handle_key_up_arrow(), and signal_handler_sdl_key_down().

void gui2::tscrollbar_container::horizontal_scrollbar_moved ( )

inline

Definition at line 219 of file scrollbar_container.hpp.

References scrollbar_moved().

Referenced by finalize_setup(), gui2::ttree_view::layout_children(), and gui2::ttree_view::resize_content().

void gui2::tscrollbar_container::impl_draw_children	(	surface &	frame_buffer,
		int	x_offset,
		int	y_offset
	)

overrideprivatevirtual

See twidget::impl_draw_children.

Reimplemented from gui2::tcontainer_.

Definition at line 824 of file scrollbar_container.cpp.

References content_grid_, gui2::twidget::draw_children(), gui2::twidget::get_visible(), gui2::tcontainer_::impl_draw_children(), and gui2::twidget::tvisible::visible.

void gui2::tscrollbar_container::layout_children ( )

overrideprivatevirtual

See twidget::layout_children.

Reimplemented from gui2::tcontainer_.

Reimplemented in gui2::tlistbox, and gui2::ttree_view.

Definition at line 837 of file scrollbar_container.cpp.

References content_grid_, gui2::tcontainer_::layout_children(), and gui2::tgrid::layout_children().

void gui2::tscrollbar_container::layout_initialise ( const bool full_initialisation )

overridevirtual

See twidget::layout_initialise.

Reimplemented from gui2::tcontainer_.

Definition at line 119 of file scrollbar_container.cpp.

References always_visible, auto_visible, content_grid_, gui2::twidget::tvisible::hidden, horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::twidget::tvisible::invisible, gui2::tcontainer_::layout_initialise(), gui2::tgrid::layout_initialise(), gui2::twidget::set_visible(), vertical_scrollbar_grid_, vertical_scrollbar_mode_, and gui2::twidget::tvisible::visible.

void gui2::tscrollbar_container::place	(	const tpoint &	origin,
		const tpoint &	size
	)

overridevirtual

See twidget::place.

Reimplemented from gui2::tcontainer_.

Reimplemented in gui2::tlistbox.

Definition at line 415 of file scrollbar_container.cpp.

References content_, content_grid_, content_visible_area_, gui2::twidget::get_best_size(), gui2::twidget::get_height(), gui2::twidget::get_origin(), gui2::twidget::get_rectangle(), gui2::twidget::get_width(), horizontal_scrollbar_, horizontal_scrollbar_grid_, horizontal_scrollbar_mode_, gui2::tcontainer_::place(), set_content_size(), set_scrollbar_button_status(), gui2::set_scrollbar_mode(), gui2::tgrid::set_visible_rectangle(), vertical_scrollbar_, vertical_scrollbar_grid_, vertical_scrollbar_mode_, gui2::tpoint::x, and gui2::tpoint::y.

Referenced by content_resize_request(), and gui2::tlistbox::place().

void gui2::tscrollbar_container::request_reduce_height ( const unsigned maximum_height )

overridevirtual

See twidget::request_reduce_height.

Todo:: Evaluate whether sizing hints are required.

Reimplemented from gui2::tcontainer_.

Definition at line 165 of file scrollbar_container.cpp.

References always_invisible, content_grid_, DBG_GUI_L, gui2::twidget::get_best_size(), gui2::twidget::get_visible(), horizontal_scrollbar_grid_, gui2::twidget::tvisible::invisible, LOG_HEADER, gui2::tgrid::request_reduce_height(), gui2::twidget::set_layout_size(), gui2::twidget::set_visible(), vertical_scrollbar_grid_, vertical_scrollbar_mode_, gui2::twidget::tvisible::visible, and gui2::tpoint::y.

void gui2::tscrollbar_container::request_reduce_width ( const unsigned maximum_width )

overridevirtual

void gui2::tscrollbar_container::scroll_horizontal_scrollbar ( const tscrollbar_::tscroll scroll )

Scrolls the horizontal scrollbar.

Parameters

scroll The position to scroll to.

Definition at line 1004 of file scrollbar_container.cpp.

References horizontal_scrollbar_, gui2::tscrollbar_::scroll(), and scrollbar_moved().

Referenced by finalize_setup().

void gui2::tscrollbar_container::scroll_vertical_scrollbar ( const tscrollbar_::tscroll scroll )

Scrolls the vertical scrollbar.

Parameters

scroll The position to scroll to.

Definition at line 995 of file scrollbar_container.cpp.

References gui2::tscrollbar_::scroll(), scrollbar_moved(), and vertical_scrollbar_.

Referenced by gui2::tlobby_main::append_to_chatbox(), finalize_setup(), gui2::tlua_interpreter::view::pg_down(), gui2::tlua_interpreter::view::pg_up(), gui2::tformula_debugger::pre_show(), and gui2::tlua_interpreter::view::update_contents().

void gui2::tscrollbar_container::scrollbar_moved ( )

private

Helper function which needs to be called after the scollbar moved.

Definition at line 1101 of file scrollbar_container.cpp.

References always_invisible, content_, content_grid_, content_visible_area_, gui2::tscrollbar_::get_item_position(), gui2::tscrollbar_::get_step_size(), gui2::twidget::get_x(), gui2::twidget::get_y(), horizontal_scrollbar_, horizontal_scrollbar_mode_, gui2::twidget::set_is_dirty(), gui2::tgrid::set_origin(), set_scrollbar_button_status(), gui2::tgrid::set_visible_rectangle(), vertical_scrollbar_, and vertical_scrollbar_mode_.

Referenced by content_resize_request(), handle_key_down_arrow(), handle_key_end(), handle_key_home(), handle_key_left_arrow(), handle_key_page_down(), handle_key_page_up(), handle_key_right_arrow(), handle_key_up_arrow(), horizontal_scrollbar_moved(), scroll_horizontal_scrollbar(), scroll_vertical_scrollbar(), set_vertical_scrollbar_item_position(), show_content_rect(), signal_handler_sdl_wheel_down(), signal_handler_sdl_wheel_left(), signal_handler_sdl_wheel_right(), signal_handler_sdl_wheel_up(), and vertical_scrollbar_moved().

void gui2::tscrollbar_container::set_content_size	(	const tpoint &	origin,
		const tpoint &	size
	)

privatevirtual

Sets the size of the content grid.

This function normally just updates the content grid but can be overridden by a subclass.

Parameters

origin	The origin for the content.
size	The size of the content.

Reimplemented in gui2::tlistbox.

Definition at line 857 of file scrollbar_container.cpp.

References content_grid_, and gui2::tgrid::place().

Referenced by place().

void gui2::tscrollbar_container::set_horizontal_scrollbar_mode ( const tscrollbar_mode scrollbar_mode )

Note: shouldn't be called after being shown in a dialog.

Definition at line 816 of file scrollbar_container.cpp.

References horizontal_scrollbar_mode_.

Referenced by gui2::implementation::tbuilder_scrollbar_panel::build(), gui2::implementation::tbuilder_scroll_label::build(), gui2::implementation::tbuilder_tree_view::build(), gui2::implementation::tbuilder_listbox::build(), and gui2::implementation::tbuilder_horizontal_listbox::build().

void gui2::tscrollbar_container::set_origin ( const tpoint & origin )

overridevirtual

See twidget::set_origin.

Reimplemented from gui2::tcontainer_.

Definition at line 455 of file scrollbar_container.cpp.

References content_, content_grid_, content_visible_area_, gui2::twidget::get_origin(), gui2::tcontainer_::set_origin(), gui2::tgrid::set_origin(), and gui2::tgrid::set_visible_rectangle().

void gui2::tscrollbar_container::set_scrollbar_button_status ( )

protected

Sets the status of the scrollbar buttons.

This is needed after the scrollbar moves so the status of the buttons will be active or inactive as needed.

Todo:: scrollbar visibility.

Todo:: scrollbar visibility.

Definition at line 913 of file scrollbar_container.cpp.

References gui2::tscrollbar_::all_items_visible(), gui2::tscrollbar_::at_begin(), gui2::tscrollbar_::at_end(), horizontal_scrollbar_, horizontal_scrollbar_grid_, gui2::tcontrol::set_active(), gui2::tscrollbar_::set_active(), vertical_scrollbar_, and vertical_scrollbar_grid_.

Referenced by content_resize_request(), place(), and scrollbar_moved().

void gui2::tscrollbar_container::set_vertical_scrollbar_item_position ( const unsigned position )

Move the vertical scrollbar to a position.

Parameters

position The position to scroll to.

Definition at line 986 of file scrollbar_container.cpp.

References scrollbar_moved(), gui2::tscrollbar_::set_item_position(), and vertical_scrollbar_.

Referenced by gui2::tlobby_main::append_to_chatbox().

void gui2::tscrollbar_container::set_vertical_scrollbar_mode ( const tscrollbar_mode scrollbar_mode )

Note: shouldn't be called after being shown in a dialog.

Definition at line 808 of file scrollbar_container.cpp.

References vertical_scrollbar_mode_.

Referenced by gui2::tlua_interpreter::view::bind(), gui2::implementation::tbuilder_scrollbar_panel::build(), gui2::implementation::tbuilder_scroll_label::build(), gui2::implementation::tbuilder_tree_view::build(), gui2::implementation::tbuilder_listbox::build(), and gui2::implementation::tbuilder_horizontal_listbox::build().

void gui2::tscrollbar_container::set_visible_rectangle ( const SDL_Rect & rectangle )

overridevirtual

See twidget::set_visible_rectangle.

Reimplemented from gui2::tcontainer_.

Definition at line 471 of file scrollbar_container.cpp.

References content_, content_grid_, content_visible_area_, gui2::twidget::get_rectangle(), sdl::intersect_rects(), gui2::tcontainer_::set_visible_rectangle(), and gui2::tgrid::set_visible_rectangle().

void gui2::tscrollbar_container::show_content_rect ( const SDL_Rect & rect )

protected

Shows a certain part of the content.

When the part to be shown is bigger as the visible viewport the top left of the wanted rect will be the top left of the viewport.

Parameters

rect	The rect which should be visible.

Definition at line 863 of file scrollbar_container.cpp.

References content_, gui2::twidget::get_height(), gui2::tscrollbar_::get_item_position(), gui2::twidget::get_width(), gui2::twidget::get_x(), gui2::twidget::get_y(), horizontal_scrollbar_, scrollbar_moved(), gui2::tscrollbar_::set_item_position(), and vertical_scrollbar_.

Referenced by gui2::tlistbox::handle_key_down_arrow(), gui2::tlistbox::handle_key_left_arrow(), gui2::tlistbox::handle_key_right_arrow(), gui2::tlistbox::handle_key_up_arrow(), gui2::ttree_view::handle_up_down_arrow(), and gui2::tlistbox::place().

void gui2::tscrollbar_container::signal_handler_sdl_key_down	(	const event::tevent	event,
		bool &	handled,
		const SDLKey	key,
		SDLMod	modifier
	)

private

Definition at line 1136 of file scrollbar_container.cpp.

References DBG_GUI_E, handle_key_down_arrow(), handle_key_end(), handle_key_home(), handle_key_left_arrow(), handle_key_page_down(), handle_key_page_up(), handle_key_right_arrow(), handle_key_up_arrow(), and LOG_HEADER.

Referenced by tscrollbar_container().

void gui2::tscrollbar_container::signal_handler_sdl_wheel_down	(	const event::tevent	event,
		bool &	handled
	)

private

Definition at line 1199 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::twidget::get_visible(), gui2::tscrollbar_::HALF_JUMP_FORWARD, LOG_HEADER, gui2::tscrollbar_::scroll(), scrollbar_moved(), vertical_scrollbar_, vertical_scrollbar_grid_, and gui2::twidget::tvisible::visible.

Referenced by tscrollbar_container().

void gui2::tscrollbar_container::signal_handler_sdl_wheel_left	(	const event::tevent	event,
		bool &	handled
	)

private

Definition at line 1214 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::twidget::get_visible(), gui2::tscrollbar_::HALF_JUMP_BACKWARDS, horizontal_scrollbar_, horizontal_scrollbar_grid_, LOG_HEADER, gui2::tscrollbar_::scroll(), scrollbar_moved(), and gui2::twidget::tvisible::visible.

Referenced by tscrollbar_container().

void gui2::tscrollbar_container::signal_handler_sdl_wheel_right	(	const event::tevent	event,
		bool &	handled
	)

private

Definition at line 1230 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::twidget::get_visible(), gui2::tscrollbar_::HALF_JUMP_FORWARD, horizontal_scrollbar_, horizontal_scrollbar_grid_, LOG_HEADER, gui2::tscrollbar_::scroll(), scrollbar_moved(), and gui2::twidget::tvisible::visible.

Referenced by tscrollbar_container().

void gui2::tscrollbar_container::signal_handler_sdl_wheel_up	(	const event::tevent	event,
		bool &	handled
	)

private

Definition at line 1184 of file scrollbar_container.cpp.

References DBG_GUI_E, gui2::twidget::get_visible(), gui2::tscrollbar_::HALF_JUMP_BACKWARDS, LOG_HEADER, gui2::tscrollbar_::scroll(), scrollbar_moved(), vertical_scrollbar_, vertical_scrollbar_grid_, and gui2::twidget::tvisible::visible.

Referenced by tscrollbar_container().

bool gui2::tscrollbar_container::vertical_scrollbar_at_end ( )

Definition at line 972 of file scrollbar_container.cpp.

References gui2::tscrollbar_::at_end(), and vertical_scrollbar_.

Referenced by gui2::tlobby_main::append_to_chatbox().

void gui2::tscrollbar_container::vertical_scrollbar_moved ( )

inline

Callback when the scrollbar moves (NOTE maybe only one callback needed).

Maybe also make protected or private and add a friend.

Definition at line 214 of file scrollbar_container.hpp.

References scrollbar_moved().

Referenced by finalize_setup().

Friends And Related Function Documentation

friend struct implementation::tbuilder_scroll_label

friend

Definition at line 45 of file scrollbar_container.hpp.

friend struct implementation::tbuilder_scrollbar_panel

friend

Definition at line 46 of file scrollbar_container.hpp.

friend class tdebug_layout_graph

friend

Definition at line 43 of file scrollbar_container.hpp.

friend class tlistbox

friend

Definition at line 48 of file scrollbar_container.hpp.

friend struct tscrollbar_container_implementation

friend

Definition at line 51 of file scrollbar_container.hpp.

friend class ttree_view

friend

Definition at line 50 of file scrollbar_container.hpp.

Member Data Documentation

tspacer* gui2::tscrollbar_container::content_

private

Dummy spacer to hold the contents location.

Definition at line 474 of file scrollbar_container.hpp.

Referenced by content_resize_height(), content_resize_request(), content_resize_width(), finalize_setup(), place(), scrollbar_moved(), set_origin(), set_visible_rectangle(), and show_content_rect().

tgrid* gui2::tscrollbar_container::content_grid_

private

The grid that holds the content.

Definition at line 471 of file scrollbar_container.hpp.

Referenced by calculate_best_size(), can_wrap(), child_populate_dirty_list(), content_grid(), content_resize_height(), content_resize_request(), content_resize_width(), disable_click_dismiss(), finalize_setup(), impl_draw_children(), layout_children(), layout_initialise(), place(), gui2::tlistbox::remove_row(), request_reduce_height(), request_reduce_width(), scrollbar_moved(), set_content_size(), set_origin(), gui2::tlistbox::set_row_shown(), set_visible_rectangle(), gui2::tlistbox::update_content_size(), and ~tscrollbar_container().

SDL_Rect gui2::tscrollbar_container::content_visible_area_

private

Cache for the visible area for the content.

The visible area for the content needs to be updated when scrolling.

Definition at line 481 of file scrollbar_container.hpp.

Referenced by content_visible_area(), gui2::ttree_view::layout_children(), gui2::tlistbox::layout_children(), place(), scrollbar_moved(), set_origin(), and set_visible_rectangle().

tscrollbar_ * gui2::tscrollbar_container::horizontal_scrollbar_

private

Definition at line 468 of file scrollbar_container.hpp.

Referenced by content_resize_width(), finalize_setup(), handle_key_home(), handle_key_left_arrow(), handle_key_right_arrow(), place(), scroll_horizontal_scrollbar(), scrollbar_moved(), set_scrollbar_button_status(), show_content_rect(), signal_handler_sdl_wheel_left(), and signal_handler_sdl_wheel_right().

tgrid * gui2::tscrollbar_container::horizontal_scrollbar_grid_

private

Definition at line 465 of file scrollbar_container.hpp.

Referenced by calculate_best_size(), content_resize_request(), content_resize_width(), finalize_setup(), layout_initialise(), place(), request_reduce_height(), request_reduce_width(), set_scrollbar_button_status(), signal_handler_sdl_wheel_left(), and signal_handler_sdl_wheel_right().

tscrollbar_mode gui2::tscrollbar_container::horizontal_scrollbar_mode_

private

Definition at line 462 of file scrollbar_container.hpp.

Referenced by content_resize_request(), content_resize_width(), get_horizontal_scrollbar_mode(), layout_initialise(), place(), request_reduce_width(), scrollbar_moved(), and set_horizontal_scrollbar_mode().

tstate gui2::tscrollbar_container::state_

private

Current state of the widget.

The state of the widget determines what to render and how the widget reacts to certain 'events'.

Definition at line 454 of file scrollbar_container.hpp.

Referenced by get_active(), and get_state().

tscrollbar_* gui2::tscrollbar_container::vertical_scrollbar_

private

tgrid* gui2::tscrollbar_container::vertical_scrollbar_grid_

private

These are valid after finalize_setup().

Definition at line 465 of file scrollbar_container.hpp.

Referenced by calculate_best_size(), content_resize_height(), content_resize_request(), finalize_setup(), layout_initialise(), place(), request_reduce_height(), request_reduce_width(), set_scrollbar_button_status(), signal_handler_sdl_wheel_down(), and signal_handler_sdl_wheel_up().

tscrollbar_mode gui2::tscrollbar_container::vertical_scrollbar_mode_

private

The mode of how to show the scrollbar.

This value should only be modified before showing, doing it while showing results in UB.

Definition at line 462 of file scrollbar_container.hpp.

Referenced by content_resize_height(), content_resize_request(), get_vertical_scrollbar_mode(), layout_initialise(), place(), request_reduce_height(), scrollbar_moved(), and set_vertical_scrollbar_mode().

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

gui/widgets/scrollbar_container.hpp
gui/widgets/scrollbar_container.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation