Base class for all interface widgets; handles many common needs, e.g. text, position, size, etc. More...

#include <hdicoreWidget.h>

Inheritance diagram for hdi::core::Widget:

[legend]

Public Types
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
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 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.

Protected Member Functions
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
void *	_data
	Private implementation data.

Friends
class	ModalDialog

class	Window

pui::Widget *	__accessImpl (const Widget &)

Detailed Description

Base class for all interface widgets; handles many common needs, e.g. text, position, size, etc.

Constructor & Destructor Documentation

◆ ~Widget()

virtual hdi::core::Widget::~Widget ( )

virtual

Destructs a Widget.

Author: GW

Date: 09/2013

◆ Widget() [1/3]

hdi::core::Widget::Widget ( )

protected

Constructs an empty Widget object.

Author: GW

Date: 09/2013

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

◆ Widget() [2/3]

hdi::core::Widget::Widget ( const Widget & w_ )

protected

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

Author: GW

Date: 09/2013

Parameters

w_	Existing Widget object

Note: This constructor should not be called directly; subclasses should "overload" it and call another ctor.

◆ Widget() [3/3]

hdi::core::Widget::Widget ( pui::Widget *& )

protected

Internal use only.

Author: GW

Date: 09/2013

Member Function Documentation

◆ _impl()

void * hdi::core::Widget::_impl ( ) const

protected

Internal use only.

Author: GW

Date: 09/2013

◆ blur()

virtual void hdi::core::Widget::blur ( ) const

virtual

Removes focus from the widget.

Author: GW

Date: 09/2013

◆ blurCallback()

virtual Callback *const hdi::core::Widget::blurCallback ( ) const

virtual

Gets the current blur callback for the widget.

Author: GW

Date: 05/2023

Returns: A pointer to the currently registered blur callback

◆ clone()

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

pure virtual

Convenience method to clone a Widget object in memory, taking its subclass type into account.

Author: GW

Date: 10/2013

Returns: A pointer to the new Widget object

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

Implemented in hdi::core::Box, hdi::core::Button, hdi::core::Checkbox, hdi::core::ColorWell, hdi::core::ColumnView, hdi::core::ComboBox, hdi::core::CustomWidget, hdi::core::Divider, hdi::core::DraggableDivider, hdi::core::HierarchicalColumnView, hdi::core::HierarchicalView, hdi::core::Label, hdi::core::ListView, hdi::core::PopupMenu, hdi::core::RadioButton, hdi::core::Slider, hdi::core::Stepper, hdi::core::TextField, hdi::core::TextView, and hdi::core::WebView.

◆ duplicate()

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

pure virtual

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)

Author: GW

Date: 11/2013

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

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

Implemented in hdi::core::Box, hdi::core::Button, hdi::core::Checkbox, hdi::core::ColorWell, hdi::core::ColumnView, hdi::core::ComboBox, hdi::core::CustomWidget, hdi::core::Divider, hdi::core::DraggableDivider, hdi::core::HierarchicalColumnView, hdi::core::HierarchicalView, hdi::core::Label, hdi::core::ListView, hdi::core::PopupMenu, hdi::core::RadioButton, hdi::core::Slider, hdi::core::Stepper, hdi::core::TextField, hdi::core::TextView, and hdi::core::WebView.

◆ enabled()

virtual bool hdi::core::Widget::enabled ( )

virtual

Gets whether the widget is enabled.

Author: GW

Date: 09/2013

Returns: true if enabled, false otherwise

Reimplemented in hdi::core::Box, hdi::core::Divider, and hdi::core::DraggableDivider.

◆ focus()

virtual void hdi::core::Widget::focus ( ) const

virtual

Forces the widget to have focus, taking it from any other focused widget of the same window.

Author: GW

Date: 09/2013

◆ focusCallback()

virtual Callback *const hdi::core::Widget::focusCallback ( ) const

virtual

Gets the current focus callback for the widget.

Author: GW

Date: 05/2023

Returns: A pointer to the currently registered focus callback

◆ frame()

virtual Rect hdi::core::Widget::frame ( ) const

virtual

Gets the widget frame.

Author: GW

Date: 09/2013

Returns: Rect describing the top-left (origin) point of the widget and its width & height, in 1x resolution coordinates

◆ hasFocus()

virtual bool hdi::core::Widget::hasFocus ( ) const

virtual

Gets whether the widget currently has focus.

Author: GW

Date: 09/2013

Returns: true for the widget being focused, false otherwise

◆ isCoreWidget()

static bool hdi::core::Widget::isCoreWidget ( const PlatformWidgetPtr widget_ )

static

Gets whether the given platform widget is a hdi_core widget.

Author: GW

Date: 01/2017

Parameters

widget_ Platform widget pointer to inspect

Returns: true if the widget is one of "ours" (i.e. is encapsulated by the hdi_core UI lib), false otherwise

◆ isEmpty()

virtual bool hdi::core::Widget::isEmpty ( ) const

virtual

Gets whether the target Widget object is empty (constructed with the default ctor)

Author: GW

Date: 09/2013

Returns: true if the target Widget object is empty, false otherwise

◆ lastClickedWidget()

static std::unique_ptr< Widget > hdi::core::Widget::lastClickedWidget ( )

static

Gets the last widget that received a click event (either by the user or programmatically)

Author: GW

Date: 09/2013

Returns: Pointer to last widget clicked

◆ lastDropWidget()

static std::unique_ptr< Widget > hdi::core::Widget::lastDropWidget ( )

static

Gets the last widget that received a drag-and-drop drop event (either by the user or programmatically)

Author: GW

Date: 09/2013

Returns: Pointer to last widget whose value changed

◆ lastPotentialReorderWidget()

static std::unique_ptr< Widget > hdi::core::Widget::lastPotentialReorderWidget ( )

static

Gets the last widget that received a potential-reorder event.

Author: GW

Date: 12/2022

Returns: Pointer to last widget to receive a potential-reorder

◆ lastReorderWidget()

static std::unique_ptr< Widget > hdi::core::Widget::lastReorderWidget ( )

static

Gets the last widget that received a reorder event.

Author: GW

Date: 12/2022

Returns: Pointer to last widget to receive a reorder

◆ lastValueChangedWidget()

static std::unique_ptr< Widget > hdi::core::Widget::lastValueChangedWidget ( )

static

Gets the last widget that received a value changed event (either by the user or programmatically)

Author: GW

Date: 09/2013

Returns: Pointer to last widget whose value changed

◆ lastValueChangingWidget()

static std::unique_ptr< Widget > hdi::core::Widget::lastValueChangingWidget ( )

static

Gets the last widget that received a value changing event (either by the user or programmatically)

Author: GW

Date: 09/2013

Returns: Pointer to last widget whose value was changing

◆ offset()

virtual void hdi::core::Widget::offset	(	const double	x_,
		const double	y_
	)

virtual

Offsets the widget from its current location by the given amounts, in 1x resolution coordinates.

Author: GW

Date: 09/2013

Parameters

x_	Distance to move the widget along the x-axis
y_	Distance to move the widget along the y-axis

◆ operator!=()

virtual bool hdi::core::Widget::operator!= ( const Widget & rhs_ ) const

virtual

Tests whether a given Widget object is not the same as another.

Author: GW

Date: 09/2013

Parameters

rhs_	Widget to compare against (righthand side of inequality operator)

Returns: true for the target and rhs_ being different UI widgets, false otherwise

◆ operator=()

virtual Widget & hdi::core::Widget::operator= ( const Widget & )

protectedvirtual

Internal use only.

Author: GW

Date: 12/2014

◆ operator==()

virtual bool hdi::core::Widget::operator== ( const Widget & rhs_ ) const

virtual

Tests whether a given Widget object is the same as another.

Author: GW

Date: 09/2013

Parameters

rhs_	Widget to compare against (righthand side of equality operator)

Returns: true for the target and rhs_ being the same UI widget, false otherwise

◆ platformWidget()

virtual PlatformWidgetPtr hdi::core::Widget::platformWidget ( ) const

virtual

Gets the platform-specific widget, around which the target object is wrapped.

Author: GW

Date: 11/2013

Returns: Pointer to platform-specific widget. See PlatformWidgetPtr typedef.

Note: Generally, you shouldn't need to call this method. Only use it if you know what you're doing. If a specific piece of UI functionality is not handled by this class (or related classes), then it should probably be added to the hdi_core library.

◆ setBlurCallback()

virtual void hdi::core::Widget::setBlurCallback ( const Callback & callback_ )

virtual

Sets the blur callback for the widget.

Author: GW

Date: 05/2023

Parameters

callback_ New callback for when the widget is blured

Note: The following widgets do not support blur callbacks: Box, Divider, Label, and WebView.

◆ setEnabled()

virtual void hdi::core::Widget::setEnabled ( const bool enable_ )

virtual

Enables or disables the widget.

Author: GW

Date: 09/2013

Parameters

enable_ true to enable, false to disable

Reimplemented in hdi::core::Box, hdi::core::Divider, and hdi::core::DraggableDivider.

◆ setFocusCallback()

virtual void hdi::core::Widget::setFocusCallback ( const Callback & callback_ )

virtual

Sets the focus callback for the widget.

Author: GW

Date: 05/2023

Parameters

callback_ New callback for when the widget is focused

Note: The following widgets do not support focus callbacks: Box, Divider, Label, and WebView.

◆ setFrame()

virtual void hdi::core::Widget::setFrame ( const Rect & frame_ )

virtual

Sets the widget frame.

Author: GW

Date: 09/2013

Parameters

frame_ New frame for the widget, in 1x resolution coordinates

◆ setHeight()

virtual void hdi::core::Widget::setHeight ( const double h_ )

virtual

Convenience method to set just the height of the target widget's frame.

Author: GW

Date: 09/2013

Parameters

h_	The height of the widget, at 1x resolution

◆ setOrigin()

virtual void hdi::core::Widget::setOrigin ( const Point & p_ )

virtual

Convenience method to set just the origin of the target widget's frame.

Author: GW

Date: 09/2013

Parameters

p_	The new location of the widget, in 1x resolution coordinates

◆ setSize()

virtual void hdi::core::Widget::setSize ( const Size & s_ )

virtual

Convenience method to set just the size of the target widget's frame.

Author: GW

Date: 09/2013

Parameters

s_	The new size of the widget, in 1x resolution coordinates

◆ setText()

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

virtual

Sets the current text value of the widget.

Author: GW

Date: 09/2013

Parameters

text_ New text value, as UTF-8 (ignored if not supported)

Note: If the widget does not support text (e.g. sliders, picture labels, etc.), this method will bail early

Reimplemented in hdi::core::ColumnView, hdi::core::Divider, hdi::core::DraggableDivider, hdi::core::HierarchicalColumnView, hdi::core::HierarchicalView, hdi::core::Box, hdi::core::Button, hdi::core::Label, hdi::core::RadioButton, and hdi::core::WebView.

◆ setTooltip()

virtual void hdi::core::Widget::setTooltip ( const std::string & tip_ )

virtual

Sets the tool tip string for the widget.

Author: GW

Date: 12/2013

Parameters

tip_	New widget tool tip string, as UTF-8

Reimplemented in hdi::core::WebView.

◆ setVisible()

virtual void hdi::core::Widget::setVisible ( const bool visible_ )

virtual

Shows or hides the widget.

Author: GW

Date: 08/2014

Parameters

visible_ true to show, false to hide

◆ setWidth()

virtual void hdi::core::Widget::setWidth ( const double w_ )

virtual

Convenience method to set just the width of the target widget's frame.

Author: GW

Date: 09/2013

Parameters

w_	The width of the widget, at 1x resolution

◆ text()

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

virtual

Gets the current text value of the widget.

Author: GW

Date: 09/2013

Returns: The current text value as UTF-8, or "" if not supported (e.g. sliders, image labels, etc.)

Reimplemented in hdi::core::Box, hdi::core::Button, hdi::core::ColumnView, hdi::core::Divider, hdi::core::DraggableDivider, hdi::core::HierarchicalColumnView, hdi::core::HierarchicalView, hdi::core::Label, hdi::core::RadioButton, and hdi::core::WebView.

◆ tooltip()

virtual std::string hdi::core::Widget::tooltip ( ) const

virtual

Gets the tool tip string for the widget.

Author: GW

Date: 12/2013

Returns: The tool tip string as UTF-8, or "" if none

Reimplemented in hdi::core::WebView.

◆ type()

virtual Type hdi::core::Widget::type ( ) const

virtual

Gets the type of the widget.

Author: GW

Date: 09/2013

Returns: The widget type

Reimplemented in hdi::core::Box, hdi::core::Divider, and hdi::core::ListView.

◆ update()

virtual void hdi::core::Widget::update ( )

virtual

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

Author: GW

Date: 09/2013

Reimplemented in hdi::core::ColumnView, hdi::core::ComboBox, hdi::core::HierarchicalColumnView, hdi::core::HierarchicalView, hdi::core::ListView, and hdi::core::PopupMenu.

◆ visible()

virtual bool hdi::core::Widget::visible ( )

virtual

Gets whether the widget is visible.

Author: GW

Date: 08/2014

Returns: true if visible, false otherwise

◆ window()

virtual Window *const hdi::core::Widget::window ( ) const

virtual

Gets the parent window of the widget.

Author: GW

Date: 09/2013

Returns: Parent window object pointer (NULL if the widget hasn't been added to one yet)

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~Widget()

◆ Widget() [1/3]

◆ Widget() [2/3]

◆ Widget() [3/3]

Member Function Documentation

◆ _impl()

◆ blur()

◆ blurCallback()

◆ clone()

◆ duplicate()

◆ enabled()

◆ focus()

◆ focusCallback()

◆ frame()

◆ hasFocus()

◆ isCoreWidget()

◆ isEmpty()

◆ lastClickedWidget()

◆ lastDropWidget()

◆ lastPotentialReorderWidget()

◆ lastReorderWidget()

◆ lastValueChangedWidget()

◆ lastValueChangingWidget()

◆ offset()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ platformWidget()

◆ setBlurCallback()

◆ setEnabled()

◆ setFocusCallback()

◆ setFrame()

◆ setHeight()

◆ setOrigin()

◆ setSize()

◆ setText()

◆ setTooltip()

◆ setVisible()

◆ setWidth()

◆ text()

◆ tooltip()

◆ type()

◆ update()

◆ visible()

◆ window()