ScrollBox Event Handlers

Typedefs
using	pcl::ScrollBox::pos_event_handler = void(Control::*)(ScrollBox &sender, int pos)
using	pcl::ScrollBox::range_event_handler = void(Control::*)(ScrollBox &sender, int minValue, int maxValue)

Functions
void	pcl::ScrollBox::OnHorizontalScrollPosUpdated (pos_event_handler handler, Control &receiver)
void	pcl::ScrollBox::OnHorizontalScrollRangeUpdated (range_event_handler handler, Control &receiver)
void	pcl::ScrollBox::OnVerticalScrollPosUpdated (pos_event_handler handler, Control &receiver)
void	pcl::ScrollBox::OnVerticalScrollRangeUpdated (range_event_handler handler, Control &receiver)

Detailed Description

Typedef Documentation

pos_event_handler

using pcl::ScrollBox::pos_event_handler = void (Control::*)( ScrollBox& sender, int pos )

Defines the prototype of a scroll position event handler.

A scroll position event is generated after the scroll position has been changed by the user, either by clicking a scroll bar with the mouse or by pressing a direction key when a scroll bar has the keyboard focus.

Parameters

sender	The control that sends a scroll position event.
pos	New scroll position in scrolling units.

Definition at line 554 of file ScrollBox.h.

range_event_handler

using pcl::ScrollBox::range_event_handler = void (Control::*)( ScrollBox& sender, int minValue, int maxValue )

Defines the prototype of a scroll range event handler.

A scroll range event is generated after a scrolling range has been changed for the horizontal or vertical scroll bars.

Parameters

sender	The control that sends a scroll range event.
minValue	New minimum scroll position.
maxValue	New maximum scroll position.

Definition at line 568 of file ScrollBox.h.

Function Documentation

OnHorizontalScrollPosUpdated()

void pcl::ScrollBox::OnHorizontalScrollPosUpdated	(	pos_event_handler	handler,
		Control &	receiver
	)

Sets the scroll position event handler for the horizontal scroll bar.

Parameters

handler	The scroll position event handler. Must be a member function of the receiver object's class.
receiver	The control that will receive horizontal scroll position events from this scroll box.

OnHorizontalScrollRangeUpdated()

void pcl::ScrollBox::OnHorizontalScrollRangeUpdated	(	range_event_handler	handler,
		Control &	receiver
	)

Sets the scroll range event handler for the horizontal scroll bar.

Parameters

handler	The scroll range event handler. Must be a member function of the receiver object's class.
receiver	The control that will receive horizontal scroll range events from this scroll box.

OnVerticalScrollPosUpdated()

void pcl::ScrollBox::OnVerticalScrollPosUpdated	(	pos_event_handler	handler,
		Control &	receiver
	)

Sets the scroll position event handler for the vertical scroll bar.

Parameters

handler	The scroll position event handler. Must be a member function of the receiver object's class.
receiver	The control that will receive vertical scroll position events from this scroll box.

OnVerticalScrollRangeUpdated()

void pcl::ScrollBox::OnVerticalScrollRangeUpdated	(	range_event_handler	handler,
		Control &	receiver
	)

Sets the scroll range event handler for the vertical scroll bar.

Parameters

handler	The scroll range event handler. Must be a member function of the receiver object's class.
receiver	The control that will receive vertical scroll range events from this scroll box.