Radio button widget, which has both a radio button and label to its right. After instantiation, a RadioButton object can be added to a RadioButtonGroup. More...

#include <hdicoreRadioButton.h>

Inheritance diagram for hdi::core::RadioButton:

[legend]

Collaboration diagram for hdi::core::RadioButton:

[legend]

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

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
	RadioButton ()
	Constructs an empty RadioButton object.

	RadioButton (const RadioButton &radio_)
	Constructs a new RadioButton object from an existing RadioButton object (copy constructor)

	RadioButton (const Point &loc_, const std::string &title_, const WindowType containerType_, const StateType state_=StateOff)
	Constructs a text radio button, using a StateType for the state and a window container type.

	RadioButton (const Point &loc_, const std::string &title_, const double width_, const StateType state_=StateOff)
	Constructs a text radio button, using a StateType for the state.

	RadioButton (const Rect &frame_, const ImageWithRolloverIDs &imageIDs_, const bool hasBorders_, const bool chosen_=false)
	Constructs an image radio button, using a bool for the state.

	RadioButton (const Rect &frame_, const SVGWithRolloverIDs &svgIDs_, const bool hasBorders_, const bool chosen_=false, const Size &dims_=Size())
	Constructs an image radio button, using a bool for the state.

virtual	~RadioButton ()
	Radio button destructor.

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

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

virtual RadioButton *	duplicate () const
	Convenience method to duplicate a RadioButton 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 radio button state.

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

virtual void	setChosen (const bool chosen_)
	Alternate setter for the radio button state.

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

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

virtual bool	hasBorders () const
	Gets whether an image radio button has borders.

virtual RadioButtonGroup *const	group () const
	Gets the radio button group that the target RadioButton belongs to.

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

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

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

virtual ImageWithRolloverIDs	imageIDs () const
	Gets the PNGI resource IDs of the widget.

virtual void	setImageIDs (const ImageWithRolloverIDs &ids_)
	Sets the PNGI resource IDs of the widget.

virtual SVGWithRolloverIDs	svgIDs () const
	Gets the SVG resource IDs of the widget.

virtual void	setSVGIDs (const SVGWithRolloverIDs &ids_)
	Sets the SVG resource IDs of the widget.

virtual bool	backgroundRollover () const
	Gets whether the background of the button should change in appearance upon mouse-over.

virtual void	setBackgroundRollover (const bool ro_)
	Sets whether the background of the button should change in appearance upon mouse-over.

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 radio button, 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.

Friends
class	RadioButtonGroup

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

Radio button widget, which has both a radio button and label to its right. After instantiation, a RadioButton object can be added to a RadioButtonGroup.

Constructor & Destructor Documentation

◆ RadioButton() [1/6]

hdi::core::RadioButton::RadioButton ( )

Constructs an empty RadioButton object.

Author: GW

Date: 09/2013

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

◆ RadioButton() [2/6]

hdi::core::RadioButton::RadioButton ( const RadioButton & radio_ )

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

Author: GW

Date: 09/2013

Parameters

radio_ Existing RadioButton object

◆ RadioButton() [3/6]

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

explicit

Constructs a text radio button, using a StateType for the state and a window container type.

Author: GW

Date: 09/2013

Parameters

loc_	Position of the radio, in 1x resolution coordinates
title_	Title of the radio, as UTF-8
containerType_	Type of window that will contain the widget
state_	Initial radio button state

Note: The containerType_ argument is necessary for this constructor because it computes the ideal width for the new radio button from the initial 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.

◆ RadioButton() [4/6]

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

explicit

Constructs a text radio button, using a StateType for the state.

Author: GW

Date: 09/2013

Parameters

loc_	Position of the radio, in 1x resolution coordinates
title_	Title of the radio, as UTF-8
width_	Width of the button, at 1x resolution
state_	Initial radio button state

◆ RadioButton() [5/6]

hdi::core::RadioButton::RadioButton	(	const Rect &	frame_,
		const ImageWithRolloverIDs &	imageIDs_,
		const bool	hasBorders_,
		const bool	chosen_ = `false`
	)

explicit

Constructs an image radio button, using a bool for the state.

Author: GW

Date: 09/2013

Parameters

frame_	Location and size of the radio, in 1x resolution coordinates
imageIDs_	PNGI resource IDs
hasBorders_	Whether the radio button will be drawn with borders
chosen_	Whether the radio button is chosen

◆ RadioButton() [6/6]

hdi::core::RadioButton::RadioButton	(	const Rect &	frame_,
		const SVGWithRolloverIDs &	svgIDs_,
		const bool	hasBorders_,
		const bool	chosen_ = `false`,
		const Size &	dims_ = `Size()`
	)

explicit

Constructs an image radio button, using a bool for the state.

Author: GW

Date: 12/2018

Parameters

frame_	Location and size of the radio, in 1x resolution coordinates
svgIDs_	SVG resource IDs
hasBorders_	Whether the radio button will be drawn with borders
chosen_	Whether the radio button is chosen
dims_	1x dimensions to use when rendering the SVG; the default value causes the widget frame dimensions to be used instead

◆ ~RadioButton()

virtual hdi::core::RadioButton::~RadioButton ( )

virtual

Radio button destructor.

Author: GW

Date: 09/2013

Member Function Documentation

◆ backgroundRollover()

virtual bool hdi::core::RadioButton::backgroundRollover ( ) const

virtual

Gets whether the background of the button should change in appearance upon mouse-over.

Author: GW

Date: 03/2015

Returns: true for showing a rollover effect, false otherwise

◆ click()

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

virtual

Simulates a click on the button.

Author: GW

Date: 09/2013

◆ clickCallback()

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

virtual

Gets the current click callback for the button.

Author: GW

Date: 09/2013

Returns: A pointer to the currently registered click callback

◆ clone()

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

virtual

Convenience method to clone a RadioButton object on the heap.

Author: GW

Date: 10/2013

Returns: A pointer to the new RadioButton object

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

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

Implements hdi::core::Widget.

◆ duplicate()

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

virtual

Convenience method to duplicate a RadioButton 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 RadioButton object (and new UI element)

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

Implements hdi::core::Widget.

◆ group()

virtual RadioButtonGroup *const hdi::core::RadioButton::group ( ) const

virtual

Gets the radio button group that the target RadioButton belongs to.

Author: GW

Date: 09/2013

Returns: A pointer to the radio button group for the target object, or NULL if none

◆ hasBorders()

virtual bool hdi::core::RadioButton::hasBorders ( ) const

virtual

Gets whether an image radio button has borders.

Author: GW

Date: 09/2013

Returns: true if the button has borders, false otherwise

◆ idealWidth()

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

static

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

Author: GW

Date: 09/2013

Parameters

text_	Radio button label, as UTF-8
height_	Known height into which the radio button 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

◆ imageIDs()

virtual ImageWithRolloverIDs hdi::core::RadioButton::imageIDs ( ) const

virtual

Gets the PNGI resource IDs of the widget.

Author: GW

Date: 03/2015

Returns: The IDs of the PNGI image resources

◆ operator=()

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

virtual

Allows one RadioButton 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 RadioButton object, but with its value updated to match that of rhs_

◆ setBackgroundRollover()

virtual void hdi::core::RadioButton::setBackgroundRollover ( const bool ro_ )

virtual

Sets whether the background of the button should change in appearance upon mouse-over.

Author: GW

Date: 03/2015

Parameters

ro_	true to show a rollover effect, false otherwise

◆ setChosen()

virtual void hdi::core::RadioButton::setChosen ( const bool chosen_ )

virtual

Alternate setter for the radio button state.

Author: GW

Date: 09/2013

Parameters

chosen_ true if the radio button is chosen, false otherwise

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

◆ setClickCallback()

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

virtual

Sets the click callback for the button.

Author: GW

Date: 09/2013

Parameters

callback_ New callback for when the button is clicked

◆ setImageIDs()

virtual void hdi::core::RadioButton::setImageIDs ( const ImageWithRolloverIDs & ids_ )

virtual

Sets the PNGI resource IDs of the widget.

Author: GW

Date: 03/2015

Parameters

ids_	New PNGI image resource IDs

◆ setState()

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

virtual

Sets the radio button state.

Author: GW

Date: 09/2013

Parameters

state_ New radio button state

◆ setSVGIDs()

virtual void hdi::core::RadioButton::setSVGIDs ( const SVGWithRolloverIDs & ids_ )

virtual

Sets the SVG resource IDs of the widget.

Author: GW

Date: 12/2018

Parameters

ids_	New SVG image resource IDs

◆ setText()

virtual void hdi::core::RadioButton::setText ( const std::string & text_ )

virtual

Sets the current text value of the radio button.

Author: GW

Date: 09/2013

Parameters

text_ New text value, as UTF-8

Note: If the widget is an image radio button, the function will bail early

Reimplemented from hdi::core::Widget.

◆ state()

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

virtual

Gets the radio button state.

Author: GW

Date: 09/2013

Returns: Current radio button state

◆ svgIDs()

virtual SVGWithRolloverIDs hdi::core::RadioButton::svgIDs ( ) const

virtual

Gets the SVG resource IDs of the widget.

Author: GW

Date: 12/2018

Returns: The IDs of the SVG image resources

◆ text()

virtual std::string hdi::core::RadioButton::text ( ) const

virtual

Gets the current text value of the radio button.

Author: GW

Date: 09/2013

Returns: The current text value, as UTF-8

Note: If the widget is an image radio button, this returns ""

Reimplemented from hdi::core::Widget.

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RadioButton() [1/6]

◆ RadioButton() [2/6]

◆ RadioButton() [3/6]

◆ RadioButton() [4/6]

◆ RadioButton() [5/6]

◆ RadioButton() [6/6]

◆ ~RadioButton()

Member Function Documentation

◆ backgroundRollover()

◆ click()

◆ clickCallback()

◆ clone()

◆ duplicate()

◆ group()

◆ hasBorders()

◆ idealWidth()

◆ imageIDs()

◆ operator=()

◆ setBackgroundRollover()

◆ setChosen()

◆ setClickCallback()

◆ setImageIDs()

◆ setState()

◆ setSVGIDs()

◆ setText()

◆ state()

◆ svgIDs()

◆ text()