Label widget, for simply displaying text or images inside a window. More...

#include <hdicoreLabel.h>

Inheritance diagram for hdi::core::Label:

Collaboration diagram for hdi::core::Label:

Public Types
enum	Alignment { UnknownAlignment = 0 , LeftAlignment = 10 , CenterAlignment = 20 , RightAlignment = 30 }
	Text alignment options.

enum	FrameShape { NoFrameShape = 0 , RectangleFrameShape = 10 , RoundedRectFrameShape = 20 , CapsuleFrameShape = 30 }
	Background frame shape drawing options.

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

	Label (const Label &label_)
	Constructs a new Label object from an existing Label object (copy constructor)

	Label (const Point &loc_, const std::string &title_, const WindowType containerType_)
	Constructs a static text label.

	Label (const Point &loc_, const std::string &title_, const double width_)
	Constructs a static text label.

	Label (const Rect &frame_, const ImageWithRolloverIDs &imageIDs_)
	Constructs a static image label.

	Label (const Rect &frame_, const SVGWithRolloverIDs &svgIDs_, const Size &dims_=Size())
	Constructs a static image label.

virtual	~Label ()
	Label destructor.

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

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

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

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

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

virtual Alignment	alignment () const
	Gets the current alignment of the label.

virtual void	setAlignment (const Alignment alignment_)
	Sets the current alignment of the label.

virtual bool	bold () const
	Gets whether the text is bold.

virtual void	setBold (const bool bold_)
	Sets the font weight.

virtual bool	italic () const
	Gets whether the text is italicized.

virtual void	setItalic (const bool italic_)
	Sets the font style.

virtual FrameShape	frameShape () const
	Gets the shape for the background of the label frame.

virtual void	setFrameShape (const FrameShape shape_)
	Sets the shape for the background of the label frame.

virtual void	frameColors (Color &light__, Color &dark__) const
	Gets the colors for the background of the label frame.

virtual void	setFrameColors (const Color &light_, const Color &dark_)
	Sets the colors for the background of the label frame.

virtual bool	textColors (Color &light__, Color &dark__) const
	Gets the colors for the text of the label.

virtual void	setTextColors (const Color &light_, const Color &dark_)
	Sets the colors for the text of the label.

virtual std::unique_ptr< TextField >	textField () const
	Gets the text field that the target label has been associated with.

virtual void	setTextField (TextField &field_)
	Sets the text field that should be focused when the label is clicked.

virtual void	removeTextField ()
	Removes the text field that should be focused when the label is clicked.

virtual std::unique_ptr< TextView >	textView () const
	Gets the text view that the target label has been associated with.

virtual void	setTextView (TextView &view_)
	Sets the text view that should be focused when the label is clicked.

virtual void	removeTextView ()
	Removes the text view that should be focused when the label is clicked.

virtual std::unique_ptr< Panel >	linkedPanel () const
	Gets the panel that the target label has been associated with.

virtual void	setLinkedPanel (const Panel &p_)
	Sets the panel that should be shown when the label is clicked.

virtual void	removeLinkedPanel ()
	Removes the panel that should be shown when the label is clicked.

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

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

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

virtual void	doubleClick ()
	Simulates a double-click on the label.

virtual Callback *const	doubleClickCallback () const
	Gets the current double-click callback for the label.

virtual void	setDoubleClickCallback (const Callback &callback_)
	Sets the double-click callback for the label.

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 label should change in appearance upon mouse-over.

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

virtual bool	draggable () const
	Gets whether dragging support for this particular widget is enabled.

virtual void	setDraggable (const bool enable_)
	Sets whether dragging support for this particular widget is enabled.

virtual std::string	dragData () const
	Gets the data that will be passed when the widget is dropped on a receiver.

virtual void	setDragData (const std::string &data_)
	Sets the data that will be passed when the widget is dropped on a receiver.

virtual bool	droppable () const
	Gets whether dropping support for this particular widget is enabled.

virtual void	setDroppable (const bool enable_)
	Sets whether dropping support for this particular widget is enabled.

virtual Callback *const	dropCallback () const
	Gets the current drop callback for the widget.

virtual void	setDropCallback (const Callback &callback_)
	Sets the drop callback for the widget.

virtual std::string	droppedData () const
	Gets the data that was passed when the widget received a drop.

virtual Point	droppedPoint () const
	Gets the point at which the drop occurred, in the widget's coordinate system.

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	idealHeight (const std::string &text_, const double width_, const WindowType containerType_)
	Gets the ideal height for a label, given its value and a known width.

static double	idealWidth (const std::string &text_, const double height_, const WindowType containerType_)
	Gets the ideal width for a label, given its value 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	TextField

class	TextView

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

Label widget, for simply displaying text or images inside a window.

Constructor & Destructor Documentation

◆ Label() [1/6]

hdi::core::Label::Label ( )

Constructs an empty Label object.

Author: GW

Date: 09/2013

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

◆ Label() [2/6]

hdi::core::Label::Label ( const Label & label_ )

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

Author: GW

Date: 09/2013

Parameters

label_ Existing Label object

◆ Label() [3/6]

hdi::core::Label::Label	(	const Point &	loc_,
		const std::string &	title_,
		const WindowType	containerType_
	)

Constructs a static text label.

Author: GW

Date: 09/2013

Parameters

loc_	Top-left location of the label, in 1x resolution coordinates
title_	Title of the label, as UTF-8
containerType_	Type of window that will contain the widget

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

◆ Label() [4/6]

hdi::core::Label::Label	(	const Point &	loc_,
		const std::string &	title_,
		const double	width_
	)

Constructs a static text label.

Author: GW

Date: 09/2013

Parameters

loc_	Top-left location of the label, in 1x resolution coordinates
title_	Title of the label, as UTF-8
width_	Width of the label, at 1x resolution

◆ Label() [5/6]

hdi::core::Label::Label	(	const Rect &	frame_,
		const ImageWithRolloverIDs &	imageIDs_
	)

Constructs a static image label.

Author: GW

Date: 09/2013

Parameters

frame_	Frame of the label, in 1x resolution coordinates
imageIDs_	PNGI resource IDs

◆ Label() [6/6]

hdi::core::Label::Label	(	const Rect &	frame_,
		const SVGWithRolloverIDs &	svgIDs_,
		const Size &	dims_ = `Size()`
	)

Constructs a static image label.

Author: GW

Date: 12/2018

Parameters

frame_	Frame of the label, in 1x resolution coordinates
svgIDs_	SVG resource IDs
dims_	1x dimensions to use when rendering the SVG; the default value causes the widget frame dimensions to be used instead

◆ ~Label()

virtual hdi::core::Label::~Label ( )

virtual

Label destructor.

Author: GW

Date: 09/2013

Member Function Documentation

◆ alignment()

virtual Alignment hdi::core::Label::alignment ( ) const

virtual

Gets the current alignment of the label.

Author: GW

Date: 09/2013

Returns: Current text alignment

◆ backgroundRollover()

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

virtual

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

Author: GW

Date: 03/2015

Returns: true for showing a rollover effect, false otherwise

◆ bold()

virtual bool hdi::core::Label::bold ( ) const

virtual

Gets whether the text is bold.

Author: GW

Date: 09/2013

Returns: true if the text is bold, false otherwise

◆ click()

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

virtual

Simulates a click on the label.

Author: GW

Date: 09/2013

◆ clickCallback()

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

virtual

Gets the current click callback for the label.

Author: GW

Date: 09/2013

Returns: A pointer to the currently registered click callback

◆ clone()

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

virtual

Convenience method to clone a Label object on the heap.

Author: GW

Date: 10/2013

Returns: A pointer to the new Label object

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

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

Implements hdi::core::Widget.

◆ doubleClick()

virtual void hdi::core::Label::doubleClick ( )

virtual

Simulates a double-click on the label.

Author: GW

Date: 03/2015

◆ doubleClickCallback()

virtual Callback *const hdi::core::Label::doubleClickCallback ( ) const

virtual

Gets the current double-click callback for the label.

Author: GW

Date: 03/2015

Returns: A pointer to the currently registered double-click callback

◆ dragData()

virtual std::string hdi::core::Label::dragData ( ) const

virtual

Gets the data that will be passed when the widget is dropped on a receiver.

Author: GW

Date: 09/2018

Returns: The droppable data

Note: A value of "" (empty string; the default) will result in the text value of the widget itself being the drag data.

◆ draggable()

virtual bool hdi::core::Label::draggable ( ) const

virtual

Gets whether dragging support for this particular widget is enabled.

Author: GW

Date: 09/2018

Returns: true if drag-and-drop source support is enabled, false otherwise

◆ dropCallback()

virtual Callback *const hdi::core::Label::dropCallback ( ) const

virtual

Gets the current drop callback for the widget.

Author: GW

Date: 09/2018

Returns: A pointer to the currently registered drop callback

◆ droppable()

virtual bool hdi::core::Label::droppable ( ) const

virtual

Gets whether dropping support for this particular widget is enabled.

Author: GW

Date: 09/2018

Returns: true if drag-and-drop destination support is enabled, false otherwise

◆ droppedData()

virtual std::string hdi::core::Label::droppedData ( ) const

virtual

Gets the data that was passed when the widget received a drop.

Author: GW

Date: 09/2018

Returns: The dropped data

Warning: The result of this method is only valid when it is called from within a drop callback.

◆ droppedPoint()

virtual Point hdi::core::Label::droppedPoint ( ) const

virtual

Gets the point at which the drop occurred, in the widget's coordinate system.

Author: GW

Date: 09/2018

Returns: The point at which the drop occurred

Warning: The result of this method is only valid when it is called from within a drop callback.

◆ duplicate()

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

virtual

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

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

Implements hdi::core::Widget.

◆ frameColors()

virtual void hdi::core::Label::frameColors	(	Color &	light__,
		Color &	dark__
	)		const

virtual

Gets the colors for the background of the label frame.

Author: GW

Date: 09/2018

Parameters

light__	Return-by-reference for the current label background frame light-UI color
dark__	Return-by-reference for the current label background frame dark-UI color

Note: Frame colors only apply to text labels.

◆ frameShape()

virtual FrameShape hdi::core::Label::frameShape ( ) const

virtual

Gets the shape for the background of the label frame.

Author: GW

Date: 09/2018

Returns: Current label background frame shape

Note: Frame shapes only apply to text labels.

◆ idealHeight()

static double hdi::core::Label::idealHeight	(	const std::string &	text_,
		const double	width_,
		const WindowType	containerType_
	)

static

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

Author: GW

Date: 09/2013

Parameters

text_	Value for the label, as UTF-8
width_	Known width into which the label must fit
containerType_	Type of window for the widget (because font sizes differ)

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

◆ idealWidth()

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

static

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

Author: GW

Date: 09/2013

Parameters

text_	Value for the label, as UTF-8
height_	Known height into which the label 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::Label::imageIDs ( ) const

virtual

Gets the PNGI resource IDs of the widget.

Author: GW

Date: 03/2015

Returns: The IDs of the PNGI image resources

◆ italic()

virtual bool hdi::core::Label::italic ( ) const

virtual

Gets whether the text is italicized.

Author: GW

Date: 09/2013

Returns: true if the text is italicized, false otherwise

◆ linkedPanel()

virtual std::unique_ptr< Panel > hdi::core::Label::linkedPanel ( ) const

virtual

Gets the panel that the target label has been associated with.

Author: GW

Date: 12/2015

Returns: Panel that will be shown in a popdown borderless fashion when the label is clicked

◆ operator=()

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

virtual

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

◆ removeLinkedPanel()

virtual void hdi::core::Label::removeLinkedPanel ( )

virtual

Removes the panel that should be shown when the label is clicked.

Author: GW

Date: 12/2015

◆ removeTextField()

virtual void hdi::core::Label::removeTextField ( )

virtual

Removes the text field that should be focused when the label is clicked.

Author: GW

Date: 04/2014

◆ removeTextView()

virtual void hdi::core::Label::removeTextView ( )

virtual

Removes the text view that should be focused when the label is clicked.

Author: GW

Date: 04/2014

◆ setAlignment()

virtual void hdi::core::Label::setAlignment ( const Alignment alignment_ )

virtual

Sets the current alignment of the label.

Author: GW

Date: 09/2013

Parameters

alignment_ New text alignment

◆ setBackgroundRollover()

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

virtual

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

Author: GW

Date: 03/2015

Parameters

ro_	true to show a rollover effect, false otherwise

◆ setBold()

virtual void hdi::core::Label::setBold ( const bool bold_ )

virtual

Sets the font weight.

Author: GW

Date: 09/2013

Parameters

bold_ true for bold, false otherwise

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

◆ setClickCallback()

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

virtual

Sets the click callback for the label.

Author: GW

Date: 09/2013

Parameters

callback_ New callback for when the label is clicked

◆ setDoubleClickCallback()

virtual void hdi::core::Label::setDoubleClickCallback ( const Callback & callback_ )

virtual

Sets the double-click callback for the label.

Author: GW

Date: 03/2015

Parameters

callback_ New callback for when the label is double-clicked

◆ setDragData()

virtual void hdi::core::Label::setDragData ( const std::string & data_ )

virtual

Sets the data that will be passed when the widget is dropped on a receiver.

Author: GW

Date: 09/2018

Parameters

data_ Data to be passed to a receiving drag-and-drop widget (when dropped)

Note: Passing a value of "" (empty string; the default) will result in the text value of the widget itself being the drag data.

◆ setDraggable()

virtual void hdi::core::Label::setDraggable ( const bool enable_ )

virtual

Sets whether dragging support for this particular widget is enabled.

Author: GW

Date: 09/2018

Parameters

enable_ true to enable drag-and-drop source support, false otherwise

◆ setDropCallback()

virtual void hdi::core::Label::setDropCallback ( const Callback & callback_ )

virtual

Sets the drop callback for the widget.

Author: GW

Date: 09/2018

Parameters

callback_ New callback for when the widget receives a drop

◆ setDroppable()

virtual void hdi::core::Label::setDroppable ( const bool enable_ )

virtual

Sets whether dropping support for this particular widget is enabled.

Author: GW

Date: 09/2018

Parameters

enable_ true to enable drag-and-drop destination support, false otherwise

◆ setFrameColors()

virtual void hdi::core::Label::setFrameColors	(	const Color &	light_,
		const Color &	dark_
	)

virtual

Sets the colors for the background of the label frame.

Author: GW

Date: 09/2018

Parameters

light_	New label background frame light-UI color
dark_	New label background frame dark-UI color

Note: Frame colors only apply to text labels.; These colors should be ignored if the frameShape() method returns FrameShapeNone.

◆ setFrameShape()

virtual void hdi::core::Label::setFrameShape ( const FrameShape shape_ )

virtual

Sets the shape for the background of the label frame.

Author: GW

Date: 09/2018

Parameters

shape_ New label background frame shape (use FrameShapeNone for no background drawing)

Note: Frame shapes only apply to text labels.

◆ setImageIDs()

virtual void hdi::core::Label::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

◆ setItalic()

virtual void hdi::core::Label::setItalic ( const bool italic_ )

virtual

Sets the font style.

Author: GW

Date: 09/2013

Parameters

italic_ true for italics, false otherwise

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

◆ setLinkedPanel()

virtual void hdi::core::Label::setLinkedPanel ( const Panel & p_ )

virtual

Sets the panel that should be shown when the label is clicked.

Author: GW

Date: 12/2015

Parameters

p_	New panel to show in a popdown borderless fashion when the label is clicked

Note: Will remove any previously linked text field or text view.

◆ setSVGIDs()

virtual void hdi::core::Label::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::Label::setText ( const std::string & text_ )

virtual

Sets the current text value of the label.

Author: GW

Date: 09/2013

Parameters

text_ New text value, as UTF-8

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

Reimplemented from hdi::core::Widget.

◆ setTextColors()

virtual void hdi::core::Label::setTextColors	(	const Color &	light_,
		const Color &	dark_
	)

virtual

Sets the colors for the text of the label.

Author: GW

Date: 09/2018

Parameters

light_	New label text light-UI color
dark_	New label text dark-UI color

Note: Text colors only apply to text labels.

◆ setTextField()

virtual void hdi::core::Label::setTextField ( TextField & field_ )

virtual

Sets the text field that should be focused when the label is clicked.

Author: GW

Date: 04/2014

Parameters

field_ New field to focus when the label is clicked

Note: Will remove any previously linked text view or panel.

◆ setTextView()

virtual void hdi::core::Label::setTextView ( TextView & view_ )

virtual

Sets the text view that should be focused when the label is clicked.

Author: GW

Date: 04/2014

Parameters

view_ New view to focus when the label is clicked

Note: Will remove any previously linked text field or panel.

◆ svgIDs()

virtual SVGWithRolloverIDs hdi::core::Label::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::Label::text ( ) const

virtual

Gets the current text value of the label.

Author: GW

Date: 09/2013

Returns: The current text value, as UTF-8

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

Reimplemented from hdi::core::Widget.

◆ textColors()

virtual bool hdi::core::Label::textColors	(	Color &	light__,
		Color &	dark__
	)		const

virtual

Gets the colors for the text of the label.

Author: GW

Date: 09/2018

Parameters

light__	Return-by-reference for the current label text light-UI color
dark__	Return-by-reference for the current label text dark-UI color

Returns: true if the default colors have been overridden (and the arguments have been filled appropriately), false otherwise

Note: Text colors only apply to text labels.

◆ textField()

virtual std::unique_ptr< TextField > hdi::core::Label::textField ( ) const

virtual

Gets the text field that the target label has been associated with.

Author: GW

Date: 04/2014

Returns: Text field that will be focused when the label is clicked

◆ textView()

virtual std::unique_ptr< TextView > hdi::core::Label::textView ( ) const

virtual

Gets the text view that the target label has been associated with.

Author: GW

Date: 04/2014

Returns: Text view that will be focused when the label is clicked

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Label() [1/6]

◆ Label() [2/6]

◆ Label() [3/6]

◆ Label() [4/6]

◆ Label() [5/6]

◆ Label() [6/6]

◆ ~Label()

Member Function Documentation

◆ alignment()

◆ backgroundRollover()

◆ bold()

◆ click()

◆ clickCallback()

◆ clone()

◆ doubleClick()

◆ doubleClickCallback()

◆ dragData()

◆ draggable()

◆ dropCallback()

◆ droppable()

◆ droppedData()

◆ droppedPoint()

◆ duplicate()

◆ frameColors()

◆ frameShape()

◆ idealHeight()

◆ idealWidth()

◆ imageIDs()

◆ italic()

◆ linkedPanel()

◆ operator=()

◆ removeLinkedPanel()

◆ removeTextField()

◆ removeTextView()

◆ setAlignment()

◆ setBackgroundRollover()

◆ setBold()

◆ setClickCallback()

◆ setDoubleClickCallback()

◆ setDragData()

◆ setDraggable()

◆ setDropCallback()

◆ setDroppable()

◆ setFrameColors()

◆ setFrameShape()

◆ setImageIDs()

◆ setItalic()

◆ setLinkedPanel()

◆ setSVGIDs()

◆ setText()

◆ setTextColors()

◆ setTextField()

◆ setTextView()

◆ svgIDs()

◆ text()

◆ textColors()

◆ textField()

◆ textView()