Base class for a scroll bar. More...

#include <scrollbar.hpp>

Inheritance diagram for gui2::tscrollbar_:

Public Types
enum	tscroll { BEGIN, ITEM_BACKWARDS, HALF_JUMP_BACKWARDS, JUMP_BACKWARDS, END, ITEM_FORWARD, HALF_JUMP_FORWARD, JUMP_FORWARD }
	scroll 'step size'. 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_ ()

void	scroll (const tscroll scroll)
	Sets the item position. More...

bool	at_begin () const
	Is the positioner at the beginning of the scrollbar? More...

bool	at_end () const
	Is the positioner at the and of the scrollbar? More...

bool	all_items_visible () const
	Are all items visible? More...

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

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

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

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

void	set_item_count (const unsigned item_count)

unsigned	get_item_count () const

void	set_item_position (const unsigned item_position)
	Note the position isn't guaranteed to be the wanted position the step size is honored. More...

unsigned	get_item_position () const

unsigned	get_visible_items () const

void	set_visible_items (const unsigned visible_items)

unsigned	get_step_size () const

void	set_step_size (const unsigned step_size)

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...

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

virtual iterator::twalker_ *	create_walker () override
	See twidget::create_walker. 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...

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

virtual void	request_reduce_width (const unsigned maximum_width) override
	See twidget::request_reduce_width. 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...

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

virtual const std::string &	get_control_type () const =0
	Returns the control_type of the control. More...

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 ()

virtual void	demand_reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a widget. More...

virtual void	request_reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a widget. More...

virtual void	demand_reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a widget. More...

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 bool	can_wrap () const
	Can the widget wrap. More...

virtual void	set_origin (const tpoint &origin)
	Sets the origin of the 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...

virtual void	layout_children ()
	Allows a widget to update its children. 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...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle)
	Sets the visible rectangle for a 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)

virtual bool	has_widget (const twidget &widget) const
	Does the widget contain the widget. More...

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
unsigned	get_positioner_offset () const

unsigned	get_positioner_length () const

virtual void	update_canvas () override
	See tcontrol::update_canvas. More...

virtual void	child_callback_positioner_moved ()
	Callback for subclasses to get notified about positioner movement. More...

Protected Member Functions inherited from gui2::tcontrol
virtual tpoint	calculate_best_size () const override
	See twidget::calculate_best_size. More...

tresolution_definition_ptr	config ()

tresolution_definition_const_ptr	config () const

void	set_config (tresolution_definition_ptr config)

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, PRESSED, FOCUSED, COUNT }
	Possible states of the widget. More...

Private Member Functions
void	set_state (const tstate state)

virtual unsigned	get_length () const =0
	Get the length of the scrollbar. More...

virtual unsigned	minimum_positioner_length () const =0
	The minimum length of the positioner. More...

virtual unsigned	maximum_positioner_length () const =0
	The maximum length of the positioner. More...

virtual unsigned	offset_before () const =0
	The number of pixels we can't use since they're used for borders. More...

virtual unsigned	offset_after () const =0
	The number of pixels we can't use since they're used for borders. More...

virtual bool	on_positioner (const tpoint &coordinate) const =0
	Is the coordinate on the positioner? More...

virtual int	on_bar (const tpoint &coordinate) const =0
	Is the coordinate on the bar? More...

virtual bool	in_orthogonal_range (const tpoint &coordinate) const =0
	Is the coordinate in the bar's orthogonal range? More...

virtual int	get_length_difference (const tpoint &original, const tpoint &current) const =0
	Gets the relevant difference in between the two positions. More...

void	recalculate ()
	Updates the scrollbar. More...

void	recalculate_positioner ()
	Updates the positioner. More...

void	move_positioner (const int distance)
	Moves the positioner. More...

void	load_config_extra ()
	Inherited from tcontrol. More...

void	signal_handler_mouse_enter (const event::tevent event, bool &handled, bool &halt)

void	signal_handler_mouse_motion (const event::tevent event, bool &handled, bool &halt, const tpoint &coordinate)

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

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

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

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

unsigned	item_count_
	The number of items the scrollbar 'holds'. More...

unsigned	item_position_
	The item the positioner is at, starts at 0. More...

unsigned	visible_items_
	The number of items which can be shown at the same time. More...

unsigned	step_size_
	Number of items moved when scrolling. More...

float	pixels_per_step_
	Number of pixels per step. More...

tpoint	mouse_
	The position the mouse was at the last movement. More...

unsigned	positioner_offset_
	The start offset of the positioner. More...

unsigned	positioner_length_
	The current length of the positioner. More...

Friends
class	tslider

Detailed Description

Base class for a scroll bar.

class will be subclassed for the horizontal and vertical scroll bar. It might be subclassed for a slider class.

To make this class generic we talk a lot about offset and length and use pure virtual functions. The classes implementing us can use the heights or widths, whichever is applicable.

The NOTIFY_MODIFIED event is send when the position of scrollbar is changed.

Common signal handlers:

connect_signal_notify_modified

Definition at line 41 of file scrollbar.hpp.

Member Enumeration Documentation

enum gui2::tscrollbar_::tscroll

scroll 'step size'.

When scrolling we always scroll a 'fixed' amount, these are the parameters for these amounts.

Enumerator
BEGIN	Go to begin position.
ITEM_BACKWARDS	Go one item towards the begin.
HALF_JUMP_BACKWARDS	Go half the visible items towards the begin.
JUMP_BACKWARDS	Go the visibile items towards the begin.
END	Go to the end position.
ITEM_FORWARD	Go one item towards the end.
HALF_JUMP_FORWARD	Go half the visible items towards the end.
JUMP_FORWARD

Definition at line 55 of file scrollbar.hpp.

enum gui2::tscrollbar_::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
PRESSED
FOCUSED
COUNT

Definition at line 191 of file scrollbar.hpp.

Constructor & Destructor Documentation

gui2::tscrollbar_::tscrollbar_ ( )

Definition at line 30 of file scrollbar.cpp.

References signal_handler_left_button_down(), signal_handler_left_button_up(), signal_handler_mouse_enter(), signal_handler_mouse_leave(), and signal_handler_mouse_motion().

Member Function Documentation

bool gui2::tscrollbar_::all_items_visible ( ) const

inline

Are all items visible?

Definition at line 93 of file scrollbar.hpp.

References item_count_, and visible_items_.

Referenced by set_item_position(), and gui2::tscrollbar_container::set_scrollbar_button_status().

bool gui2::tscrollbar_::at_begin ( ) const

inline

Is the positioner at the beginning of the scrollbar?

Definition at line 77 of file scrollbar.hpp.

References item_position_.

Referenced by gui2::tscrollbar_container::set_scrollbar_button_status().

bool gui2::tscrollbar_::at_end ( ) const

inline

Is the positioner at the and of the scrollbar?

Note both begin and end might be true at the same time.

Definition at line 87 of file scrollbar.hpp.

References item_count_, item_position_, and visible_items_.

Referenced by gui2::tscrollbar_container::set_scrollbar_button_status(), and gui2::tscrollbar_container::vertical_scrollbar_at_end().

virtual void gui2::tscrollbar_::child_callback_positioner_moved ( )

inlineprotectedvirtual

Callback for subclasses to get notified about positioner movement.

Todo:: This is a kind of hack due to the fact there's no simple callback slot mechanism. See whether we can implement a generic way to attach callback which would remove quite some extra code.

Reimplemented in gui2::tslider.

Definition at line 181 of file scrollbar.hpp.

Referenced by move_positioner().

bool gui2::tscrollbar_::get_active ( ) const

overridevirtual

See tcontrol::get_active.

Implements gui2::tcontrol.

Definition at line 117 of file scrollbar.cpp.

References DISABLED, and state_.

Referenced by set_active().

unsigned gui2::tscrollbar_::get_item_count ( ) const

inline

Definition at line 121 of file scrollbar.hpp.

References item_count_.

Referenced by gui2::adjust_scrollbar_mode(), gui2::implementation::tbuilder_slider::build(), gui2::tslider::get_maximum_value(), and gui2::tslider::get_value_label().

unsigned gui2::tscrollbar_::get_item_position ( ) const

inline

Definition at line 131 of file scrollbar.hpp.

References item_position_.

Referenced by gui2::adjust_scrollbar_mode(), gui2::tslider::get_value(), gui2::tslider::get_value_label(), gui2::tscrollbar_container::get_vertical_scrollbar_item_position(), gui2::tscrollbar_container::scrollbar_moved(), and gui2::tscrollbar_container::show_content_rect().

virtual unsigned gui2::tscrollbar_::get_length ( ) const

privatepure virtual

Get the length of the scrollbar.

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by move_positioner(), and recalculate().

virtual int gui2::tscrollbar_::get_length_difference	(	const tpoint &	original,
		const tpoint &	current
	)		const

privatepure virtual

Gets the relevant difference in between the two positions.

This function is used to determine how much the positioner needs to be moved.

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by signal_handler_mouse_motion().

unsigned gui2::tscrollbar_::get_positioner_length ( ) const

inlineprotected

Definition at line 162 of file scrollbar.hpp.

References positioner_length_.

Referenced by gui2::tvertical_scrollbar::on_bar(), gui2::thorizontal_scrollbar::on_bar(), gui2::tslider::on_bar(), gui2::tvertical_scrollbar::on_positioner(), gui2::thorizontal_scrollbar::on_positioner(), and gui2::tslider::on_positioner().

unsigned gui2::tscrollbar_::get_positioner_offset ( ) const

inlineprotected

Definition at line 157 of file scrollbar.hpp.

References positioner_offset_.

Referenced by gui2::tvertical_scrollbar::on_bar(), gui2::thorizontal_scrollbar::on_bar(), gui2::tslider::on_bar(), gui2::tvertical_scrollbar::on_positioner(), gui2::thorizontal_scrollbar::on_positioner(), and gui2::tslider::on_positioner().

unsigned gui2::tscrollbar_::get_state ( ) const

overridevirtual

See tcontrol::get_state.

Implements gui2::tcontrol.

Definition at line 122 of file scrollbar.cpp.

References state_.

unsigned gui2::tscrollbar_::get_step_size ( ) const

inline

Definition at line 146 of file scrollbar.hpp.

References step_size_.

Referenced by gui2::tslider::get_value(), gui2::tscrollbar_container::scrollbar_moved(), gui2::tslider::set_maximum_value(), and gui2::tslider::set_minimum_value().

unsigned gui2::tscrollbar_::get_visible_items ( ) const

inline

Definition at line 136 of file scrollbar.hpp.

References visible_items_.

virtual bool gui2::tscrollbar_::in_orthogonal_range ( const tpoint & coordinate ) const

privatepure virtual

Is the coordinate in the bar's orthogonal range?

Parameters

coordinate Coordinate to test whether it's in-range.

Returns: Whether the location is in the bar's. orthogonal range.

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by signal_handler_mouse_motion().

void gui2::tscrollbar_::load_config_extra ( )

privatevirtual

Inherited from tcontrol.

Reimplemented from gui2::tcontrol.

Definition at line 306 of file scrollbar.cpp.

References gui2::tcontrol::canvas(), offset_after(), and offset_before().

virtual unsigned gui2::tscrollbar_::maximum_positioner_length ( ) const

privatepure virtual

The maximum length of the positioner.

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by move_positioner(), recalculate(), and recalculate_positioner().

virtual unsigned gui2::tscrollbar_::minimum_positioner_length ( ) const

privatepure virtual

The minimum length of the positioner.

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by move_positioner(), recalculate(), and recalculate_positioner().

void gui2::tscrollbar_::move_positioner ( const int distance )

private

Moves the positioner.

Parameters

distance The distance moved, negative to begin, positive to end.

Definition at line 254 of file scrollbar.cpp.

References child_callback_positioner_moved(), gui2::event::tdispatcher::fire(), get_length(), item_count_, item_position_, maximum_positioner_length(), minimum_positioner_length(), gui2::event::NOTIFY_MODIFIED, offset_after(), offset_before(), pixels_per_step_, positioner_length_, positioner_offset_, step_size_, update_canvas(), and visible_items_.

Referenced by signal_handler_mouse_motion().

virtual unsigned gui2::tscrollbar_::offset_after ( ) const

privatepure virtual

The number of pixels we can't use since they're used for borders.

These are the pixels after the widget (right side if horizontal, bottom side if vertical).

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by load_config_extra(), move_positioner(), and recalculate().

virtual unsigned gui2::tscrollbar_::offset_before ( ) const

privatepure virtual

The number of pixels we can't use since they're used for borders.

These are the pixels before the widget (left side if horizontal, top side if vertical).

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by load_config_extra(), move_positioner(), and recalculate().

virtual int gui2::tscrollbar_::on_bar ( const tpoint & coordinate ) const

privatepure virtual

Is the coordinate on the bar?

Parameters

coordinate Coordinate to test whether it's on the bar.

Returns: Whether the location on the bar is.

Return values

-1	Coordinate is on the bar before positioner.
0	Coordinate is not on the bar.
1	Coordinate is on the bar after the positioner.

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by signal_handler_left_button_down().

virtual bool gui2::tscrollbar_::on_positioner ( const tpoint & coordinate ) const

privatepure virtual

Is the coordinate on the positioner?

Parameters

coordinate Coordinate to test whether it's on the positioner.

Returns: Whether the location on the positioner is.

Implemented in gui2::tslider, gui2::thorizontal_scrollbar, and gui2::tvertical_scrollbar.

Referenced by signal_handler_left_button_down(), signal_handler_left_button_up(), and signal_handler_mouse_motion().

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

overridevirtual

See twidget::place.

Reimplemented from gui2::tcontrol.

Definition at line 102 of file scrollbar.cpp.

References gui2::tcontrol::place(), and recalculate().

void gui2::tscrollbar_::recalculate ( )

private

Updates the scrollbar.

Needs to be called when someting changes eg number of items or available size. It can only be called once we have a size otherwise we can't calulate a thing.

Todo:: In the MP lobby it can happen that a listbox has first zero items, then gets filled and since there are no visible items the second assert after this block will be triggered. Use this ugly hack to avoid that case. (This hack also added the gui/widgets/window.hpp include.)

Definition at line 168 of file scrollbar.cpp.

References ERR_GUI_G, get_length(), gui2::twidget::get_window(), gui2::twindow::invalidate_layout(), item_count_, item_position_, LOG_HEADER, maximum_positioner_length(), minimum_positioner_length(), offset_after(), offset_before(), pixels_per_step_, positioner_length_, positioner_offset_, recalculate_positioner(), set_item_position(), step_size_, update_canvas(), and visible_items_.

Referenced by place(), set_item_count(), set_step_size(), and set_visible_items().

void gui2::tscrollbar_::recalculate_positioner ( )

private

Updates the positioner.

This is a helper for recalculate().

Definition at line 240 of file scrollbar.cpp.

References maximum_positioner_length(), minimum_positioner_length(), and positioner_length_.

Referenced by recalculate().

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

Sets the item position.

We scroll a predefined step.

Parameters

scroll 'step size' to scroll.

Definition at line 54 of file scrollbar.cpp.

References BEGIN, END, gui2::event::tdispatcher::fire(), HALF_JUMP_BACKWARDS, HALF_JUMP_FORWARD, ITEM_BACKWARDS, item_count_, ITEM_FORWARD, item_position_, JUMP_BACKWARDS, JUMP_FORWARD, gui2::event::NOTIFY_MODIFIED, set_item_position(), and visible_items_.

void gui2::tscrollbar_::set_active ( const bool active )

overridevirtual

See tcontrol::set_active.

Implements gui2::tcontrol.

Definition at line 110 of file scrollbar.cpp.

References DISABLED, ENABLED, get_active(), and set_state().

Referenced by gui2::tscrollbar_container::set_scrollbar_button_status(), gui2::tpreferences::toggle_slider_pair_callback(), and gui2::tchat_log::controller::update_view_from_model().

void gui2::tscrollbar_::set_item_count ( const unsigned item_count )

inline

Definition at line 116 of file scrollbar.hpp.

References item_count_, and recalculate().

Referenced by gui2::adjust_scrollbar_mode(), gui2::tslider::set_maximum_value(), gui2::tslider::set_minimum_value(), and gui2::set_scrollbar_mode().

void gui2::tscrollbar_::set_item_position ( const unsigned item_position )

Note the position isn't guaranteed to be the wanted position the step size is honored.

The value will be rouded down.

Definition at line 127 of file scrollbar.cpp.

References all_items_visible(), item_count_, item_position_, pixels_per_step_, positioner_offset_, step_size_, update_canvas(), and visible_items_.

Referenced by gui2::adjust_scrollbar_mode(), recalculate(), scroll(), gui2::tslider::set_maximum_value(), gui2::tslider::set_minimum_value(), gui2::set_scrollbar_mode(), gui2::tslider::set_value(), gui2::tscrollbar_container::set_vertical_scrollbar_item_position(), and gui2::tscrollbar_container::show_content_rect().

void gui2::tscrollbar_::set_state ( const tstate state )

private

Definition at line 160 of file scrollbar.cpp.

References gui2::twidget::set_is_dirty(), and state_.

Referenced by set_active(), signal_handler_left_button_down(), signal_handler_left_button_up(), signal_handler_mouse_leave(), and signal_handler_mouse_motion().

void gui2::tscrollbar_::set_step_size ( const unsigned step_size )

inline

Definition at line 150 of file scrollbar.hpp.

References recalculate(), and step_size_.

Referenced by gui2::implementation::tbuilder_slider::build(), and gui2::tpreferences::initialize_members().

void gui2::tscrollbar_::set_visible_items ( const unsigned visible_items )

inline

Definition at line 140 of file scrollbar.hpp.

References recalculate(), and visible_items_.

Referenced by gui2::adjust_scrollbar_mode(), and gui2::set_scrollbar_mode().

void gui2::tscrollbar_::signal_handler_left_button_down	(	const event::tevent	event,
		bool &	handled
	)

private

Definition at line 384 of file scrollbar.cpp.

References DBG_GUI_E, gui2::event::tdispatcher::fire(), gui2::get_mouse_position(), gui2::twidget::get_window(), gui2::twidget::get_x(), gui2::twidget::get_y(), HALF_JUMP_BACKWARDS, HALF_JUMP_FORWARD, LOG_HEADER, mouse_, gui2::twindow::mouse_capture(), gui2::event::NOTIFY_MODIFIED, on_bar(), on_positioner(), PRESSED, scroll(), set_state(), gui2::tpoint::x, and gui2::tpoint::y.

Referenced by tscrollbar_().

void gui2::tscrollbar_::signal_handler_left_button_up	(	const event::tevent	event,
		bool &	handled
	)

private

Definition at line 417 of file scrollbar.cpp.

References DBG_GUI_E, ENABLED, FOCUSED, gui2::get_mouse_position(), gui2::twidget::get_window(), gui2::twidget::get_x(), gui2::twidget::get_y(), LOG_HEADER, gui2::twindow::mouse_capture(), on_positioner(), PRESSED, set_state(), state_, gui2::tpoint::x, and gui2::tpoint::y.

Referenced by tscrollbar_().

void gui2::tscrollbar_::signal_handler_mouse_enter	(	const event::tevent	event,
		bool &	handled,
		bool &	halt
	)

private

Definition at line 316 of file scrollbar.cpp.

References DBG_GUI_E, gui2::get_mouse_position(), LOG_HEADER, and signal_handler_mouse_motion().

Referenced by tscrollbar_().

void gui2::tscrollbar_::signal_handler_mouse_leave	(	const event::tevent	event,
		bool &	handled
	)

private

Definition at line 372 of file scrollbar.cpp.

References DBG_GUI_E, ENABLED, FOCUSED, LOG_HEADER, set_state(), and state_.

Referenced by tscrollbar_().

void gui2::tscrollbar_::signal_handler_mouse_motion	(	const event::tevent	event,
		bool &	handled,
		bool &	halt,
		const tpoint &	coordinate
	)

private

Definition at line 326 of file scrollbar.cpp.

References DBG_GUI_E, DISABLED, ENABLED, FOCUSED, get_length_difference(), gui2::twidget::get_x(), gui2::twidget::get_y(), in_orthogonal_range(), LOG_HEADER, mouse_, move_positioner(), on_positioner(), PRESSED, set_state(), state_, gui2::tpoint::x, and gui2::tpoint::y.

Referenced by signal_handler_mouse_enter(), and tscrollbar_().

void gui2::tscrollbar_::update_canvas ( )

overrideprotectedvirtual

See tcontrol::update_canvas.

After a recalculation the canvasses also need to be updated.

Reimplemented from gui2::tcontrol.

Reimplemented in gui2::tslider.

Definition at line 149 of file scrollbar.cpp.

References gui2::tcontrol::canvas(), positioner_length_, positioner_offset_, and gui2::twidget::set_is_dirty().

Referenced by move_positioner(), recalculate(), set_item_position(), and gui2::tslider::update_canvas().

Friends And Related Function Documentation

friend class tslider

friend

Todo:: Abstract the code so this friend is no longer needed.

Definition at line 44 of file scrollbar.hpp.

Member Data Documentation

unsigned gui2::tscrollbar_::item_count_

private

The number of items the scrollbar 'holds'.

Definition at line 209 of file scrollbar.hpp.

Referenced by all_items_visible(), at_end(), get_item_count(), move_positioner(), recalculate(), scroll(), set_item_count(), and set_item_position().

unsigned gui2::tscrollbar_::item_position_

private

The item the positioner is at, starts at 0.

Definition at line 212 of file scrollbar.hpp.

Referenced by at_begin(), at_end(), get_item_position(), move_positioner(), recalculate(), scroll(), and set_item_position().

tpoint gui2::tscrollbar_::mouse_

private

The position the mouse was at the last movement.

This is used during dragging the positioner.

Definition at line 244 of file scrollbar.hpp.

Referenced by signal_handler_left_button_down(), and signal_handler_mouse_motion().

float gui2::tscrollbar_::pixels_per_step_

private

Number of pixels per step.

The number of pixels the positioner needs to move to go to the next step. Note if there is too little space it can happen 1 pixel does more than 1 step.

Definition at line 237 of file scrollbar.hpp.

Referenced by move_positioner(), recalculate(), and set_item_position().

unsigned gui2::tscrollbar_::positioner_length_

private

The current length of the positioner.

Definition at line 254 of file scrollbar.hpp.

Referenced by get_positioner_length(), move_positioner(), recalculate(), recalculate_positioner(), and update_canvas().

unsigned gui2::tscrollbar_::positioner_offset_

private

The start offset of the positioner.

This takes the offset before in consideration.

Definition at line 251 of file scrollbar.hpp.

Referenced by get_positioner_offset(), move_positioner(), recalculate(), set_item_position(), and update_canvas().

tstate gui2::tscrollbar_::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 206 of file scrollbar.hpp.

Referenced by get_active(), get_state(), set_state(), signal_handler_left_button_up(), signal_handler_mouse_leave(), and signal_handler_mouse_motion().

unsigned gui2::tscrollbar_::step_size_

private

Number of items moved when scrolling.

The step size is the minimum number of items we scroll through when we move. Normally this value is 1, we can move per item. But for example sliders want for example to move per 5 items.

Definition at line 228 of file scrollbar.hpp.

Referenced by get_step_size(), move_positioner(), recalculate(), set_item_position(), and set_step_size().

unsigned gui2::tscrollbar_::visible_items_

private

The number of items which can be shown at the same time.

As long as all items are visible we don't need to scroll.

Definition at line 219 of file scrollbar.hpp.

Referenced by all_items_visible(), at_end(), get_visible_items(), move_positioner(), recalculate(), scroll(), set_item_position(), and set_visible_items().

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