SectionBar Event Handlers

Typedefs
using	pcl::SectionBar::check_event_handler = void(Control::*)(SectionBar &sender, bool checked)
using	pcl::SectionBar::section_event_handler = void(Control::*)(SectionBar &sender, Control &section, bool start)

Functions
void	pcl::SectionBar::OnCheck (check_event_handler handler, Control &receiver)
void	pcl::SectionBar::OnToggleSection (section_event_handler handler, Control &receiver)

Detailed Description

Typedef Documentation

check_event_handler

using pcl::SectionBar::check_event_handler = void (Control::*)( SectionBar& sender, bool checked )

Defines the prototype of a check event handler

A check event is generated when the user toggles the state of the check box in a checkable section bar, either by clicking it with the mouse, or by focusing it and pressing the space bar key.

Parameters

sender	The control that sends a check event.
checked	True if the check box is now checked in the sender section bar. False if the check box is currently unchecked.

Definition at line 327 of file SectionBar.h.

section_event_handler

using pcl::SectionBar::section_event_handler = void (Control::*)( SectionBar& sender, Control& section, bool start )

Defines the prototype of a section event handler.

A section event is generated when the user clicks on this section bar to collapse or extend the managed section control.

For each section event, two subevents are generated: one before the collapse/extend operation, and a second one once the operation has been completed.

Parameters

sender	The control that sends a section event.
section	The section control that has been collapsed or extended.
start	True if this is a first subevent that is being sent before the collapse/extend operation; false if it is a second subevent, sent after having completed the operation.

Definition at line 298 of file SectionBar.h.

Function Documentation

OnCheck()

void pcl::SectionBar::OnCheck	(	check_event_handler	handler,
		Control &	receiver
	)

Sets the check event handler for this SectionBar control.

Parameters

handler	The check event handler. Must be a member function of the receiver object's class.
receiver	The control that will receive check events from this SectionBar.

OnToggleSection()

void pcl::SectionBar::OnToggleSection	(	section_event_handler	handler,
		Control &	receiver
	)

Sets the section event handler for this SectionBar control.

Parameters

handler	The section event handler. Must be a member function of the receiver object's class.
receiver	The control that will receive section events from this SectionBar.