Popup menu widget, allowing for a single preset entry to be chosen at a time. More...

#include <hdicorePopupMenu.h>

Inheritance diagram for hdi::core::PopupMenu:

Collaboration diagram for hdi::core::PopupMenu:

Public Types
typedef std::vector< PopupEntry >	EntryVector

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

	PopupMenu (const PopupMenu &popup_)
	Constructs a new PopupMenu object from an existing PopupMenu object (copy constructor)

	PopupMenu (const Point &loc_, const double width_)
	Constructs an empty PopupMenu widget at a given location of a given width.

	PopupMenu (const Point &loc_, const double width_, const EntryVector &entries_, const int32_t initialIndex_)
	Constructs a PopupMenu widget with a list of entries and an initial index selection.

	PopupMenu (const Point &loc_, const double width_, const EntryVector &entries_, const std::string &initialID_)
	Constructs a PopupMenu widget with a list of entries and an initial ID selection.

virtual	~PopupMenu ()
	PopupMenu destructor.

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

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

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

virtual void	selectUnknownEntry ()
	In the case of a mixed popup state, this will create and select a blank entry.

virtual void	deselectUnknownEntry ()
	In the case of a (prior) mixed popup state, this will deselect and destroy the blank entry.

virtual int32_t	currentIndex () const
	Gets the index of the currently selected entry.

virtual bool	setCurrentIndex (const int32_t index_)
	Sets the currently selected entry by index.

virtual std::string	currentID () const
	Gets the ID of the currently selected entry.

virtual bool	setCurrentID (const std::string &id_)
	Sets the currently selected entry by ID.

virtual std::string	currentValue () const
	Gets the string value of the currently selected entry.

virtual bool	setCurrentValue (const std::string &value_)
	Sets the currently selected entry by string value.

virtual std::unique_ptr< PopupEntry >	currentEntry () const
	Gets the current entry object.

virtual bool	currentUserData (void *&data__) const
	Gets the user data for the current entry.

virtual const std::vector< std::shared_ptr< PopupEntry > > *const	entries () const
	Gets the entries vector.

virtual void	setEntries (const EntryVector &entries_)
	Allows the entries in an popup menu to be changed out entirely.

virtual bool	hasEntry (const std::string &id_) const
	Gets whether the entries vector already contains an entry, based on its ID.

virtual std::shared_ptr< PopupEntry >	entryWithID (const std::string &id_) const
	Gets the entry with the given ID, provided it exists within the widget.

virtual bool	pushEntry (const PopupEntry &entry_)
	Pushes an entry onto the list (i.e. at the end)

virtual bool	popEntry (PopupEntry &entry__)
	Pops an entry off the list (i.e. from the end)

virtual bool	insertEntry (const std::string &id_, const PopupEntry &entry_)
	Inserts an entry into the list of entries at a given position.

virtual bool	removeEntry (const std::string &id_, PopupEntry &entry__)
	Removes a specific entry from the list of entries.

virtual void	clearEntries ()
	Clears all entries contained by the widget.

virtual void	valueChanged ()
	Simulates the popup menu having its value changed.

virtual Callback *const	valueChangedCallback () const
	Gets the value changed callback for the popup menu.

virtual void	setValueChangedCallback (const Callback &callback_)
	Sets the value changed callback.

virtual void	update ()
	Force the popup menu to update its entries.

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 PopupMenu	FontMenu (const Point &loc_, const double width_, const Font &font_)
	Static named constructor for creating a font menu with a preselected font object.

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

Popup menu widget, allowing for a single preset entry to be chosen at a time.

Constructor & Destructor Documentation

◆ PopupMenu() [1/5]

hdi::core::PopupMenu::PopupMenu ( )

Constructs an empty PopupMenu object.

Author: GW

Date: 09/2013

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

◆ PopupMenu() [2/5]

hdi::core::PopupMenu::PopupMenu ( const PopupMenu & popup_ )

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

Author: GW

Date: 09/2013

Parameters

popup_ Existing PopupMenu object

◆ PopupMenu() [3/5]

hdi::core::PopupMenu::PopupMenu	(	const Point &	loc_,
		const double	width_
	)

Constructs an empty PopupMenu widget at a given location of a given width.

Author: GW

Date: 09/2013

Parameters

loc_	Position of the popup, in 1x resolution coordinates
width_	Width of the popup, at 1x resolution

◆ PopupMenu() [4/5]

hdi::core::PopupMenu::PopupMenu	(	const Point &	loc_,
		const double	width_,
		const EntryVector &	entries_,
		const int32_t	initialIndex_
	)

Constructs a PopupMenu widget with a list of entries and an initial index selection.

Author: GW

Date: 09/2013

Parameters

loc_	Position of the popup, in 1x resolution coordinates
width_	Width of the popup, at 1x resolution
entries_	Vector of string entries, whose order in the popup will match the vector
initialIndex_	Initial index to select (must exist in entries_, and must not be a separator)

◆ PopupMenu() [5/5]

hdi::core::PopupMenu::PopupMenu	(	const Point &	loc_,
		const double	width_,
		const EntryVector &	entries_,
		const std::string &	initialID_
	)

Constructs a PopupMenu widget with a list of entries and an initial ID selection.

Author: GW

Date: 09/2013

Parameters

loc_	Position of the popup, in 1x resolution coordinates
width_	Width of the popup, at 1x resolution
entries_	Vector of string entries, whose order in the popup will match that in the vector
initialID_	Initial ID to select, as UTF-8 (must exist in entries_, and must not be a separator)

◆ ~PopupMenu()

virtual hdi::core::PopupMenu::~PopupMenu ( )

virtual

PopupMenu destructor.

Author: GW

Date: 09/2013

Member Function Documentation

◆ clearEntries()

virtual void hdi::core::PopupMenu::clearEntries ( )

virtual

Clears all entries contained by the widget.

Author: GW

Date: 09/2013

◆ clone()

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

virtual

Convenience method to clone a PopupMenu object on the heap.

Author: GW

Date: 10/2013

Returns: A pointer to the new PopupMenu object

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

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

Implements hdi::core::Widget.

◆ currentEntry()

virtual std::unique_ptr< PopupEntry > hdi::core::PopupMenu::currentEntry ( ) const

virtual

Gets the current entry object.

Author: GW

Date: 09/2013

Returns: The PopupEntry object for the currently selected item

◆ currentID()

virtual std::string hdi::core::PopupMenu::currentID ( ) const

virtual

Gets the ID of the currently selected entry.

Author: GW

Date: 09/2013

Returns: UTF-8 ID string of the currently selected entry, or "" if no entry is currently selected

◆ currentIndex()

virtual int32_t hdi::core::PopupMenu::currentIndex ( ) const

virtual

Gets the index of the currently selected entry.

Author: GW

Date: 09/2013

Returns: The index number of the currently selected entry, or -1 if no entry is selected

◆ currentUserData()

virtual bool hdi::core::PopupMenu::currentUserData ( void *& data__ ) const

virtual

Gets the user data for the current entry.

Author: GW

Date: 09/2013

Parameters

data__ Return-by-reference for the current user data; ignore if false is returned

Returns: true if the method succeeds in acquiring the contained entry data, false otherwise

◆ currentValue()

virtual std::string hdi::core::PopupMenu::currentValue ( ) const

virtual

Gets the string value of the currently selected entry.

Author: GW

Date: 09/2013

Returns: Value string of the popup menu, as UTF-8

◆ deselectUnknownEntry()

virtual void hdi::core::PopupMenu::deselectUnknownEntry ( )

virtual

In the case of a (prior) mixed popup state, this will deselect and destroy the blank entry.

Author: GW

Date: 09/2013

◆ duplicate()

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

virtual

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

Note: The new popup menu will have copies of all entries present in the target, but be aware that copies of the user data in each entry cannot be made (because they are simply void* variables). As such, the user data in the copies will simply be set to NULL by this method. This does not apply to PopupMenu objects previously created with the FontMenu() named constructor.

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

Implements hdi::core::Widget.

◆ entries()

virtual const std::vector< std::shared_ptr< PopupEntry > > *const hdi::core::PopupMenu::entries ( ) const

virtual

Gets the entries vector.

Author: GW

Date: 09/2013

Returns: The entries vector for the target widget, containing all currently known entries

Note: Modifying any value in an entry will not cause the widget to update automatically; call update() to update the UI for changes made to entry data.

◆ entryWithID()

virtual std::shared_ptr< PopupEntry > hdi::core::PopupMenu::entryWithID ( const std::string & id_ ) const

virtual

Gets the entry with the given ID, provided it exists within the widget.

Author: GW

Date: 02/2023

Parameters

id_	ID of the entry to search for

Returns: The entry with the given ID, or NULL if not found

◆ FontMenu()

static PopupMenu hdi::core::PopupMenu::FontMenu	(	const Point &	loc_,
		const double	width_,
		const Font &	font_
	)

static

Static named constructor for creating a font menu with a preselected font object.

Author: GW

Date: 09/2013

Parameters

loc_	Position of the popup, in 1x resolution coordinates
width_	Width of the popup, at 1x resolution
font_	Font face to select by default

Returns: A PopupMenu object, filled with all fonts available to the app

Note: The PopupEntry objects, with which the PopupMenu is filled, themselves contain pointers to Font objects

◆ hasEntry()

virtual bool hdi::core::PopupMenu::hasEntry ( const std::string & id_ ) const

virtual

Gets whether the entries vector already contains an entry, based on its ID.

Author: GW

Date: 09/2013

Parameters

id_	ID of the entry to search for, as UTF-8

Returns: true if the widget already contains an entry with the given ID, false otherwise

◆ insertEntry()

virtual bool hdi::core::PopupMenu::insertEntry	(	const std::string &	id_,
		const PopupEntry &	entry_
	)

virtual

Inserts an entry into the list of entries at a given position.

Author: GW

Date: 09/2013

Parameters

id_	Existing entry immediately before the position at which the new entry will be inserted, as UTF-8
entry_	New entry object to insert into the list of entries

Returns: true if the entry is inserted successfully, false otherwise

Note: If the entry for id_ doesn't exist in the list, the new entry will not be inserted.; If the passed entry is already present in the list (based on its ID), it will not be inserted.

◆ operator=()

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

virtual

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

◆ popEntry()

virtual bool hdi::core::PopupMenu::popEntry ( PopupEntry & entry__ )

virtual

Pops an entry off the list (i.e. from the end)

Author: GW

Date: 09/2013

Parameters

entry__ Return-by-reference for the popped entry, so the caller can inspect which one was removed

Returns: true if an entry was popped and acquired, false otherwise

Warning: If you created the target PopupMenu object with the FontMenu named constructor, then the PopupEntry object will contain a Font object pointer for which the caller will become responsible (i.e. the caller must cast the user data void* to a Font* and delete the Font object when the PopupEntry object is no longer needed).

◆ pushEntry()

virtual bool hdi::core::PopupMenu::pushEntry ( const PopupEntry & entry_ )

virtual

Pushes an entry onto the list (i.e. at the end)

Author: GW

Date: 09/2013

Parameters

entry_ New entry object to insert into the list of entries

Returns: true if the entry is pushed successfully, false otherwise

Note: If the entry is already present in the list (based on its ID), it will not be inserted.

◆ removeEntry()

virtual bool hdi::core::PopupMenu::removeEntry	(	const std::string &	id_,
		PopupEntry &	entry__
	)

virtual

Removes a specific entry from the list of entries.

Author: GW

Date: 09/2013

Parameters

id_	ID of the entry to be removed, as UTF-8
entry__	Return-by-reference for the removed entry, so the caller can inspect which one was removed

Returns: true if an entry was removed and acquired, false otherwise

Warning: If you created the target PopupMenu object with the FontMenu named constructor, then the PopupEntry object will contain a Font object pointer for which the caller will become responsible (i.e. the caller must cast the user data void* to a Font* and delete the Font object when the PopupEntry object is no longer needed).

◆ selectUnknownEntry()

virtual void hdi::core::PopupMenu::selectUnknownEntry ( )

virtual

In the case of a mixed popup state, this will create and select a blank entry.

Author: GW

Date: 09/2013

◆ setCurrentID()

virtual bool hdi::core::PopupMenu::setCurrentID ( const std::string & id_ )

virtual

Sets the currently selected entry by ID.

Author: GW

Date: 09/2013

Parameters

id_	ID of new value to select in the popup menu, as UTF-8

Returns: true if the entry with the given ID was selected, or false if invalid

◆ setCurrentIndex()

virtual bool hdi::core::PopupMenu::setCurrentIndex ( const int32_t index_ )

virtual

Sets the currently selected entry by index.

Author: GW

Date: 09/2013

Parameters

index_ New index to select

Returns: true if the selection occurred successfully, or false if e.g. out of range

◆ setCurrentValue()

virtual bool hdi::core::PopupMenu::setCurrentValue ( const std::string & value_ )

virtual

Sets the currently selected entry by string value.

Author: GW

Date: 09/2013

Parameters

value_ New value to set for the popup menu (if it exists as an entry), as UTF-8

Returns: true if the value was set, false otherwise

◆ setEntries()

virtual void hdi::core::PopupMenu::setEntries ( const EntryVector & entries_ )

virtual

Allows the entries in an popup menu to be changed out entirely.

Author: GW

Date: 09/2013

Parameters

entries_ New set of entries that the widget will contain

◆ setValueChangedCallback()

virtual void hdi::core::PopupMenu::setValueChangedCallback ( const Callback & callback_ )

virtual

Sets the value changed callback.

Author: GW

Date: 09/2013

Parameters

callback_ New callback for when the popup menu's value has changed

◆ update()

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

virtual

Force the popup menu to update its entries.

Author: GW

Date: 12/2013

Reimplemented from hdi::core::Widget.

◆ valueChanged()

virtual void hdi::core::PopupMenu::valueChanged ( )

virtual

Simulates the popup menu having its value changed.

Author: GW

Date: 09/2013

◆ valueChangedCallback()

virtual Callback *const hdi::core::PopupMenu::valueChangedCallback ( ) const

virtual

Gets the value changed callback for the popup menu.

Author: GW

Date: 09/2013

Returns: A pointer to the currently registered value changed callback

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PopupMenu() [1/5]

◆ PopupMenu() [2/5]

◆ PopupMenu() [3/5]

◆ PopupMenu() [4/5]

◆ PopupMenu() [5/5]

◆ ~PopupMenu()

Member Function Documentation

◆ clearEntries()

◆ clone()

◆ currentEntry()

◆ currentID()

◆ currentIndex()

◆ currentUserData()

◆ currentValue()

◆ deselectUnknownEntry()

◆ duplicate()

◆ entries()

◆ entryWithID()

◆ FontMenu()

◆ hasEntry()

◆ insertEntry()

◆ operator=()

◆ popEntry()

◆ pushEntry()

◆ removeEntry()

◆ selectUnknownEntry()

◆ setCurrentID()

◆ setCurrentIndex()

◆ setCurrentValue()

◆ setEntries()

◆ setValueChangedCallback()

◆ update()

◆ valueChanged()

◆ valueChangedCallback()