button_state_descriptor_t Struct Reference [Button Widget Helpers]

#include <button_helper.hpp>

List of all members.

Public Member Functions
	button_state_descriptor_t ()
button_state_descriptor_t &	operator= (const button_state_descriptor_t &x)
Public Attributes
std::string	alt_text_m
dictionary_t	contributing_m
button_hit_proc_t	hit_proc_m
modifiers_t	modifier_set_m
std::string	name_m
any_regular_t	value_m

---

Detailed Description

A button_t widget is a collection of latches, each with its own unique information. Users select which latch they want the button to currently represent by holding down a series of modifier keys (alt, ctrl, etc.) When the user clicks on a button, the current latch is said to fire, at which point the related callback proc is called with the retained state information for this latch.

This struct is what is used to convey all the necessary information to the button_t constructor for a single latch state. An array of these button descriptors are passed to the button during construction time.

Definition at line 79 of file button_helper.hpp.

---

Constructor & Destructor Documentation

button_state_descriptor_t

(

)

Default constructor.

Definition at line 84 of file button_helper.hpp.

---

Member Function Documentation

button_state_descriptor_t& operator=

(

const button_state_descriptor_t &

x )

Definition at line 106 of file button_helper.hpp.

---

Member Data Documentation

std::string alt_text_m

Additional help text for the widget when the user pauses over it

Definition at line 92 of file button_helper.hpp.

dictionary_t contributing_m

(used internally) The retained contributing state information for this button state

Definition at line 104 of file button_helper.hpp.

button_hit_proc_t hit_proc_m

The notification proc to be called when this state is fired.

Definition at line 98 of file button_helper.hpp.

modifiers_t modifier_set_m

The modifier state required to select this button state

Definition at line 95 of file button_helper.hpp.

std::string name_m

The name of this button state

Definition at line 89 of file button_helper.hpp.

any_regular_t value_m

(used internally) The retained state of the property model for this button state

Definition at line 101 of file button_helper.hpp.