Checkbox widget, which has both a checkbox "button" and a text label to its right. More...

#include <hdicoreCheckbox.h>

Inheritance diagram for hdi::core::Checkbox:

Collaboration diagram for hdi::core::Checkbox:

Public Types
enum	StateType { StateMixed = -1 , StateOff = 0 , StateOn = 1 }
	Describes the state of a checkbox.

Public Types inherited from hdi::core::Widget
enum	Type { UnknownType = 0 , BoxType = 10 , ButtonType = 20 , CheckboxType = 30 , ColumnViewType = 40 , ComboBoxType = 50 , ColorWellType = 60 , CustomType = 70 , DividerType = 80 , HierarchicalColumnViewType = 85 , HierarchicalViewType = 90 , LabelType = 100 , ListViewType = 110 , PopupMenuType = 120 , RadioButtonType = 130 , SliderType = 140 , StepperType = 150 , TextFieldType = 160 , TextViewType = 170 , WebViewType = 180 }
	Supported widget types.

Public Member Functions
	Checkbox ()
	Constructs an empty Checkbox object.

	Checkbox (const Checkbox &checkbox_)
	Constructs a new Checkbox object from an existing Checkbox object (copy constructor)

	Checkbox (const Point &loc_, const std::string &label_, const WindowType containerType_, const StateType state_=StateOff)
	Constructs a checkbox (using a StateType) and a window container type.

	Checkbox (const Point &loc_, const std::string &label_, const double width_, const StateType state_=StateOff)
	Constructs a checkbox (using a StateType)

virtual	~Checkbox ()
	Checkbox destructor.

virtual Checkbox &	operator= (const Checkbox &rhs_)
	Allows one Checkbox object to be assigned from another.

virtual Checkbox *	clone () const
	Convenience method to clone a Checkbox object on the heap.

virtual Checkbox *	duplicate () const
	Convenience method to duplicate a Checkbox object, creating a new and identical UI element to the target (but not belonging to the same containing window)

virtual StateType	state () const
	Gets the checkbox state.

virtual void	setState (const StateType state_)
	Sets the checkbox state.

virtual void	setChecked (const bool checked_)
	Alternate setter for the checkbox state.

virtual void	click ()
	Simulates a click on the checkbox.

virtual Callback *const	clickCallback () const
	Gets the current click callback for the checkbox.

virtual void	setClickCallback (const Callback &callback_)
	Sets the click callback for the checkbox.

Public Member Functions inherited from hdi::core::Widget
virtual	~Widget ()
	Destructs a Widget.

virtual Widget *	clone () const =0
	Convenience method to clone a Widget object in memory, taking its subclass type into account.

virtual Widget *	duplicate () const =0
	Convenience method to duplicate a Widget object, creating a new and identical UI element to the target (but not belonging to the same containing window)

virtual PlatformWidgetPtr	platformWidget () const
	Gets the platform-specific widget, around which the target object is wrapped.

virtual bool	isEmpty () const
	Gets whether the target Widget object is empty (constructed with the default ctor)

virtual bool	operator== (const Widget &rhs_) const
	Tests whether a given Widget object is the same as another.

virtual bool	operator!= (const Widget &rhs_) const
	Tests whether a given Widget object is not the same as another.

virtual Type	type () const
	Gets the type of the widget.

virtual Window *const	window () const
	Gets the parent window of the widget.

virtual Rect	frame () const
	Gets the widget frame.

virtual void	setFrame (const Rect &frame_)
	Sets the widget frame.

virtual void	offset (const double x_, const double y_)
	Offsets the widget from its current location by the given amounts, in 1x resolution coordinates.

virtual std::string	text () const
	Gets the current text value of the widget.

virtual void	setText (const std::string &text_)
	Sets the current text value of the widget.

virtual bool	enabled ()
	Gets whether the widget is enabled.

virtual void	setEnabled (const bool enable_)
	Enables or disables the widget.

virtual bool	visible ()
	Gets whether the widget is visible.

virtual void	setVisible (const bool visible_)
	Shows or hides the widget.

virtual void	setOrigin (const Point &p_)
	Convenience method to set just the origin of the target widget's frame.

virtual void	setSize (const Size &s_)
	Convenience method to set just the size of the target widget's frame.

virtual void	setWidth (const double w_)
	Convenience method to set just the width of the target widget's frame.

virtual void	setHeight (const double h_)
	Convenience method to set just the height of the target widget's frame.

virtual bool	hasFocus () const
	Gets whether the widget currently has focus.

virtual void	focus () const
	Forces the widget to have focus, taking it from any other focused widget of the same window.

virtual Callback *const	focusCallback () const
	Gets the current focus callback for the widget.

virtual void	setFocusCallback (const Callback &callback_)
	Sets the focus callback for the widget.

virtual void	blur () const
	Removes focus from the widget.

virtual Callback *const	blurCallback () const
	Gets the current blur callback for the widget.

virtual void	setBlurCallback (const Callback &callback_)
	Sets the blur callback for the widget.

virtual std::string	tooltip () const
	Gets the tool tip string for the widget.

virtual void	setTooltip (const std::string &tip_)
	Sets the tool tip string for the widget.

virtual void	update ()
	Force the widget to update (i.e. cause it to redraw)

Static Public Member Functions
static double	idealWidth (const std::string &text_, const double height_, const WindowType containerType_)
	Gets the ideal width for a checkbox, given its label and a known height.

Static Public Member Functions inherited from hdi::core::Widget
static bool	isCoreWidget (const PlatformWidgetPtr widget_)
	Gets whether the given platform widget is a hdi_core widget.

static std::unique_ptr< Widget >	lastClickedWidget ()
	Gets the last widget that received a click event (either by the user or programmatically)

static std::unique_ptr< Widget >	lastValueChangingWidget ()
	Gets the last widget that received a value changing event (either by the user or programmatically)

static std::unique_ptr< Widget >	lastValueChangedWidget ()
	Gets the last widget that received a value changed event (either by the user or programmatically)

static std::unique_ptr< Widget >	lastDropWidget ()
	Gets the last widget that received a drag-and-drop drop event (either by the user or programmatically)

static std::unique_ptr< Widget >	lastPotentialReorderWidget ()
	Gets the last widget that received a potential-reorder event.

static std::unique_ptr< Widget >	lastReorderWidget ()
	Gets the last widget that received a reorder event.

Additional Inherited Members
Protected Member Functions inherited from hdi::core::Widget
void *	_impl () const
	Internal use only.

	Widget ()
	Constructs an empty Widget object.

	Widget (const Widget &w_)
	Constructs a new Widget object from an existing Widget object (copy constructor)

	Widget (pui::Widget *&)
	Internal use only.

virtual Widget &	operator= (const Widget &)
	Internal use only.

Protected Attributes inherited from hdi::core::Widget
void *	_data
	Private implementation data.

Detailed Description

Checkbox widget, which has both a checkbox "button" and a text label to its right.

Constructor & Destructor Documentation

◆ Checkbox() [1/4]

hdi::core::Checkbox::Checkbox ( )

Constructs an empty Checkbox object.

Author: GW

Date: 09/2013

Note: To test if a Checkbox object is empty, call isEmpty() on it; Empty Checkbox objects do not relate to any actual UI widget; they are designed to be "receivers" of some other Checkbox object via the overloaded assignment operator. Empty Checkbox objects are useless until such time (though it is safe to call any of their methods).

◆ Checkbox() [2/4]

hdi::core::Checkbox::Checkbox ( const Checkbox & checkbox_ )

Constructs a new Checkbox object from an existing Checkbox object (copy constructor)

Author: GW

Date: 09/2013

Parameters

checkbox_ Existing Checkbox object

◆ Checkbox() [3/4]

hdi::core::Checkbox::Checkbox	(	const Point &	loc_,
		const std::string &	label_,
		const WindowType	containerType_,
		const StateType	state_ = `StateOff`
	)

explicit

Constructs a checkbox (using a StateType) and a window container type.

Author: GW

Date: 09/2013

Parameters

loc_	Top-left location of the checkbox, in 1x resolution coordinates
label_	String for the checkbox, as UTF-8
containerType_	Type of window that will contain the widget
state_	Initial checkbox state

Note: The containerType_ argument is necessary for this constructor because it computes the ideal width for the new checkbox from the initial checkbox label string. However, Adobe uses different font sizes for different types of windows, and we can't correctly compute the width without knowing what font size to use.

◆ Checkbox() [4/4]

hdi::core::Checkbox::Checkbox	(	const Point &	loc_,
		const std::string &	label_,
		const double	width_,
		const StateType	state_ = `StateOff`
	)

explicit

Constructs a checkbox (using a StateType)

Author: GW

Date: 09/2013

Parameters

loc_	Top-left location of the checkbox, in 1x resolution coordinates
label_	String for the checkbox, as UTF-8
width_	Width of the checkbox and its label, at 1x resolution
state_	Initial checkbox state

◆ ~Checkbox()

virtual hdi::core::Checkbox::~Checkbox ( )

virtual

Checkbox destructor.

Author: GW

Date: 09/2013

Member Function Documentation

◆ click()

virtual void hdi::core::Checkbox::click ( )

virtual

Simulates a click on the checkbox.

Author: GW

Date: 09/2013

◆ clickCallback()

virtual Callback *const hdi::core::Checkbox::clickCallback ( ) const

virtual

Gets the current click callback for the checkbox.

Author: GW

Date: 09/2013

Returns: A pointer to the currently registered click callback

◆ clone()

virtual Checkbox * hdi::core::Checkbox::clone ( ) const

virtual

Convenience method to clone a Checkbox object on the heap.

Author: GW

Date: 10/2013

Returns: A pointer to the new Checkbox object

Note: If you subclass Checkbox, you MUST overload this method yourself! If you don't and/or your clone() method does not return an instance of your Checkbox subclass, you will experience "object slicing" when adding the widget to a window.

Warning: The caller must manage the memory for the returned Checkbox object.

Implements hdi::core::Widget.

◆ duplicate()

virtual Checkbox * hdi::core::Checkbox::duplicate ( ) const

virtual

Convenience method to duplicate a Checkbox object, creating a new and identical UI element to the target (but not belonging to the same containing window)

Author: GW

Date: 11/2013

Returns: A pointer to the new Checkbox object (and new UI element)

Warning: The caller must manage the memory for the returned Checkbox object.

Implements hdi::core::Widget.

◆ idealWidth()

static double hdi::core::Checkbox::idealWidth	(	const std::string &	text_,
		const double	height_,
		const WindowType	containerType_
	)

static

Gets the ideal width for a checkbox, given its label and a known height.

Author: GW

Date: 09/2013

Parameters

text_	Checkbox label, as UTF-8
height_	Known height into which the checkbox must fit
containerType_	Type of window for the widget (because font sizes differ)

Returns: Ideal width for the given text to fit into the given height, at 1x resolution

◆ operator=()

virtual Checkbox & hdi::core::Checkbox::operator= ( const Checkbox & rhs_ )

virtual

Allows one Checkbox object to be assigned from another.

Author: GW

Date: 10/2013

Parameters

rhs_	Righthand side of the = operator; the object to copy values from

Returns: The target Checkbox object, but with its value updated to match that of rhs_

◆ setChecked()

virtual void hdi::core::Checkbox::setChecked ( const bool checked_ )

virtual

Alternate setter for the checkbox state.

Author: GW

Date: 09/2013

Parameters

checked_ true if the checkbox is checked, false otherwise

Note: If you need to set a mixed state, use the other setter

◆ setClickCallback()

virtual void hdi::core::Checkbox::setClickCallback ( const Callback & callback_ )

virtual

Sets the click callback for the checkbox.

Author: GW

Date: 09/2013

Parameters

callback_ New callback for when the checkbox is clicked

◆ setState()

virtual void hdi::core::Checkbox::setState ( const StateType state_ )

virtual

Sets the checkbox state.

Author: GW

Date: 09/2013

Parameters

state_ New checkbox state

◆ state()

virtual StateType hdi::core::Checkbox::state ( ) const

virtual

Gets the checkbox state.

Author: GW

Date: 09/2013

Returns: Current checkbox state

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Checkbox() [1/4]

◆ Checkbox() [2/4]

◆ Checkbox() [3/4]

◆ Checkbox() [4/4]

◆ ~Checkbox()

Member Function Documentation

◆ click()

◆ clickCallback()

◆ clone()

◆ duplicate()

◆ idealWidth()

◆ operator=()

◆ setChecked()

◆ setClickCallback()

◆ setState()

◆ state()