A UI component displaying a list of presets with sorting, filtering, and favorite management. More...

#include <preset_browser.h>

Inheritance diagram for PresetList:

Classes
class	AuthorAscendingComparator

class	AuthorDescendingComparator

class	FavoriteAscendingComparator

class	FavoriteComparator

class	FavoriteDescendingComparator

class	FileDateAscendingComparator

class	FileDateDescendingComparator

class	FileNameAscendingComparator

class	FileNameDescendingComparator

class	Listener
	Interface for receiving preset selection and deletion requests. More...

class	StyleAscendingComparator

class	StyleDescendingComparator

Public Types
enum	Column { kNone , kStar , kName , kStyle , kAuthor , kDate , kNumColumns }

enum	MenuOptions { kCancel , kOpenFileLocation , kRename , kDelete , kNumMenuOptions }

Public Member Functions
	PresetList ()
	Constructs a PresetList.

void	paintBackground (Graphics &g) override
	Paints the background of the section. Calls paintContainer, heading, knobs, children.

void	paintBackgroundShadow (Graphics &g) override
	Stub for painting background shadows. Overridden by subclasses if needed.

void	resized () override
	Called when the component is resized. Arranges layout of child components.

void	setPresets (Array< File > presets)
	Sets the array of presets to display.

void	mouseWheelMove (const MouseEvent &e, const MouseWheelDetails &wheel) override

int	getRowFromPosition (float mouse_position)
	Converts a mouse Y position into a row index.

int	getRowHeight ()
	Gets the row height in pixels.

void	mouseMove (const MouseEvent &e) override

void	mouseExit (const MouseEvent &e) override

void	respondToMenuCallback (int result)
	Handles actions from the preset context menu.

void	menuClick (const MouseEvent &e)
	Called on right-click to show a context menu.

void	leftClick (const MouseEvent &e)
	Called on left-click to select, rename, or favorite a preset.

void	mouseDown (const MouseEvent &e) override

void	textEditorReturnKeyPressed (TextEditor &text_editor) override

void	textEditorFocusLost (TextEditor &text_editor) override

void	textEditorEscapeKeyPressed (TextEditor &editor) override

void	scrollBarMoved (ScrollBar *scroll_bar, double range_start) override

void	setScrollBarRange ()

void	finishRename ()
	Finalizes a preset rename operation.

void	reloadPresets ()
	Reloads the currently displayed presets from disk.

void	shiftSelectedPreset (int indices)
	Moves the selected preset up or down by a number of indices.

void	redoCache ()
	Updates the cached images for rows after sorting or filtering.

void	filter (String filter_string, const std::set< std::string > &styles)
	Filters the displayed presets by name, author, and styles.

int	getSelectedIndex ()
	Gets the index of the currently selected preset.

int	getScrollableRange ()
	Gets the scrollable height of the presets.

void	initOpenGlComponents (OpenGlWrapper &open_gl) override
	Initializes all OpenGL components in this section and sub-sections.

void	renderOpenGlComponents (OpenGlWrapper &open_gl, bool animate) override
	Renders all OpenGL components in this section and sub-sections.

void	destroyOpenGlComponents (OpenGlWrapper &open_gl) override
	Destroys all OpenGL components in this section and sub-sections.

void	addListener (Listener *listener)
	Adds a listener for preset events.

void	setCurrentFolder (const File &folder)
	Sets the current folder to display presets from.

Public Member Functions inherited from SynthSection
	SynthSection (const String &name)
	Constructs a SynthSection with a given name.

virtual	~SynthSection ()=default

void	setParent (const SynthSection *parent)
	Sets the parent SynthSection.

float	findValue (Skin::ValueId value_id) const
	Finds a value in the skin overrides or from the parent if not found locally.

virtual void	reset ()
	Resets the section and all sub-sections.

virtual void	paint (Graphics &g) override
	Called when the component should paint itself.

virtual void	paintSidewaysHeadingText (Graphics &g)
	Paints the section name heading text vertically if sideways_heading_ is true.

virtual void	paintHeadingText (Graphics &g)
	Paints the heading text for this section, either sideways or horizontally.

virtual void	setSkinValues (const Skin &skin, bool top_level)
	Sets skin values (colors, sizes) and applies them to sub-sections.

void	setSkinOverride (Skin::SectionOverride skin_override)

virtual void	repaintBackground ()
	Requests a repaint of the background.

void	showPopupBrowser (SynthSection *owner, Rectangle< int > bounds, std::vector< File > directories, String extensions, std::string passthrough_name, std::string additional_folders_name)
	Shows a file browser popup (e.g., for loading samples or wavetables).

void	updatePopupBrowser (SynthSection *owner)
	Updates the currently visible popup browser if any.

void	showPopupSelector (Component *source, Point< int > position, const PopupItems &options, std::function< void(int)> callback, std::function< void()> cancel={ })
	Shows a popup selector with options.

void	showDualPopupSelector (Component *source, Point< int > position, int width, const PopupItems &options, std::function< void(int)> callback)
	Shows a dual popup selector for hierarchical selection.

void	showPopupDisplay (Component *source, const std::string &text, BubbleComponent::BubblePlacement placement, bool primary)
	Shows a brief popup display (like a tooltip).

void	hidePopupDisplay (bool primary)
	Hides the currently shown popup display.

virtual void	loadFile (const File &file)
	Loads a file (e.g., a sample or wavetable). Overridden by subclasses.

virtual File	getCurrentFile ()
	Gets the currently loaded file. Overridden by subclasses.

virtual std::string	getFileName ()
	Gets the name of the currently loaded file. Overridden by subclasses.

virtual std::string	getFileAuthor ()
	Gets the author metadata of the currently loaded file. Overridden by subclasses.

virtual void	paintContainer (Graphics &g)
	Paints the container background, body, heading, etc.

virtual void	paintBody (Graphics &g, Rectangle< int > bounds)
	Paints the body background within given bounds.

virtual void	paintBorder (Graphics &g, Rectangle< int > bounds)
	Paints the border around given bounds.

virtual void	paintBody (Graphics &g)
	Paints the section body background using the entire component area.

virtual void	paintBorder (Graphics &g)
	Paints the border around the entire component.

int	getComponentShadowWidth ()
	Gets the width of shadow around components.

virtual void	paintTabShadow (Graphics &g)
	Paints a tab-like shadow effect around the component.

void	paintTabShadow (Graphics &g, Rectangle< int > bounds)
	Paints a tab shadow effect within specified bounds.

virtual void	setSizeRatio (float ratio)
	Sets the size ratio for scaling UI elements.

void	paintKnobShadows (Graphics &g)
	Paints knob shadows for all sliders.

Font	getLabelFont ()
	Gets a suitable font for label text.

void	setLabelFont (Graphics &g)
	Sets the Graphics context font and color for labels.

void	drawLabelConnectionForComponents (Graphics &g, Component left, Component right)
	Draws a rectangular connection between labels of two components.

void	drawLabelBackground (Graphics &g, Rectangle< int > bounds, bool text_component=false)
	Draws a background for a label area.

void	drawLabelBackgroundForComponent (Graphics &g, Component *component)
	Draws label background for a specific component.

Rectangle< int >	getDividedAreaBuffered (Rectangle< int > full_area, int num_sections, int section, int buffer)
	Divides an area into equal sections with buffering, returns the specified section.

Rectangle< int >	getDividedAreaUnbuffered (Rectangle< int > full_area, int num_sections, int section, int buffer)
	Divides an area into equal sections without extra buffering, returns the specified section.

Rectangle< int >	getLabelBackgroundBounds (Rectangle< int > bounds, bool text_component=false)
	Gets the background bounds for a label.

Rectangle< int >	getLabelBackgroundBounds (Component *component, bool text_component=false)
	Gets the label background bounds for a component.

void	drawLabel (Graphics &g, String text, Rectangle< int > component_bounds, bool text_component=false)
	Draws a label text below a component.

void	drawLabelForComponent (Graphics &g, String text, Component *component, bool text_component=false)
	Draws a label for a given component.

void	drawTextBelowComponent (Graphics &g, String text, Component *component, int space, int padding=0)
	Draws text below a component with optional padding.

virtual void	paintChildrenShadows (Graphics &g)
	Paints shadows for child sections.

void	paintChildrenBackgrounds (Graphics &g)
	Paints the backgrounds for all child sections.

void	paintOpenGlChildrenBackgrounds (Graphics &g)
	Paints the backgrounds for all OpenGL child components.

void	paintChildBackground (Graphics &g, SynthSection *child)
	Paints a child's background specifically.

void	paintChildShadow (Graphics &g, SynthSection *child)
	Paints a child's shadow specifically.

void	paintOpenGlBackground (Graphics &g, OpenGlComponent *child)
	Paints the background of an OpenGlComponent child.

void	drawTextComponentBackground (Graphics &g, Rectangle< int > bounds, bool extend_to_label)
	Draws a background for a text component area.

void	drawTempoDivider (Graphics &g, Component *sync)
	Draws a divider line for tempo-related controls.

virtual void	sliderValueChanged (Slider *moved_slider) override
	Called when a slider value changes. Updates the synth parameter accordingly.

virtual void	buttonClicked (Button *clicked_button) override
	Called when a button is clicked. Updates the synth parameter accordingly.

virtual void	guiChanged (SynthButton *button) override
	Called when a SynthButton state changes (GUI interaction).

std::map< std::string, SynthSlider * >	getAllSliders ()
	Gets all sliders registered in this section.

std::map< std::string, ToggleButton * >	getAllButtons ()
	Gets all toggle buttons registered in this section.

std::map< std::string, ModulationButton * >	getAllModulationButtons ()
	Gets all modulation buttons registered in this section.

virtual void	setActive (bool active)
	Sets the active state of this section and sub-sections.

bool	isActive () const
	Checks if the section is currently active.

virtual void	animate (bool animate)
	Triggers animation state change in sub-sections if needed.

virtual void	setAllValues (vital::control_map &controls)
	Sets values for all known parameters from a control map.

virtual void	setValue (const std::string &name, vital::mono_float value, NotificationType notification)
	Sets a single parameter value for a known control.

void	addModulationButton (ModulationButton *button, bool show=true)
	Adds a modulation button to this section.

void	addSubSection (SynthSection *section, bool show=true)
	Adds a subsection (another SynthSection) as a child.

void	removeSubSection (SynthSection *section)
	Removes a previously added subsection.

virtual void	setScrollWheelEnabled (bool enabled)
	Enables or disables scroll wheel support for this section and sub-sections.

ToggleButton *	activator () const
	Gets the activator toggle button if any.

void	setSkinValues (std::map< Skin::ValueId, float > values)
	Sets custom skin values for this section.

void	setSkinValue (Skin::ValueId id, float value)
	Sets a single skin value override.

float	getTitleWidth ()

float	getPadding ()

float	getPowerButtonOffset () const

float	getKnobSectionHeight ()

float	getSliderWidth ()

float	getSliderOverlap ()

float	getSliderOverlapWithSpace ()

float	getTextComponentHeight ()

float	getStandardKnobSize ()

float	getTotalKnobHeight ()

float	getTextSectionYOffset ()

float	getModButtonWidth ()

float	getModFontSize ()

float	getWidgetMargin ()

float	getWidgetRounding ()

float	getSizeRatio () const

int	getPopupWidth () const

int	getDualPopupWidth () const

Public Member Functions inherited from SynthButton::ButtonListener
virtual	~ButtonListener ()
	Virtual destructor.

Static Public Attributes
static constexpr int	kNumCachedRows = 50

static constexpr float	kRowSizeHeightPercent = 0.04f

static constexpr float	kStarWidthPercent = 0.04f

static constexpr float	kNameWidthPercent = 0.35f

static constexpr float	kStyleWidthPercent = 0.18f

static constexpr float	kAuthorWidthPercent = 0.25f

static constexpr float	kDateWidthPercent = 0.18f

static constexpr float	kScrollSensitivity = 200.0f

Static Public Attributes inherited from SynthSection
static constexpr int	kDefaultPowerButtonOffset = 0

static constexpr float	kPowerButtonPaddingPercent = 0.29f

static constexpr float	kTransposeHeightPercent = 0.5f

static constexpr float	kTuneHeightPercent = 0.4f

static constexpr float	kJointModulationRadiusPercent = 0.1f

static constexpr float	kJointModulationExtensionPercent = 0.6666f

static constexpr float	kPitchLabelPercent = 0.33f

static constexpr float	kJointLabelHeightPercent = 0.4f

static constexpr double	kTransposeMouseSensitivity = 0.2

static constexpr float	kJointLabelBorderRatioX = 0.05f

static constexpr int	kDefaultBodyRounding = 4

static constexpr int	kDefaultLabelHeight = 10

static constexpr int	kDefaultLabelBackgroundHeight = 16

static constexpr int	kDefaultLabelBackgroundWidth = 56

static constexpr int	kDefaultLabelBackgroundRounding = 4

static constexpr int	kDefaultPadding = 2

static constexpr int	kDefaultPopupMenuWidth = 150

static constexpr int	kDefaultDualPopupMenuWidth = 340

static constexpr int	kDefaultStandardKnobSize = 32

static constexpr int	kDefaultKnobThickness = 2

static constexpr float	kDefaultKnobModulationAmountThickness = 2.0f

static constexpr int	kDefaultKnobModulationMeterSize = 43

static constexpr int	kDefaultKnobModulationMeterThickness = 4

static constexpr int	kDefaultModulationButtonWidth = 64

static constexpr int	kDefaultModFontSize = 10

static constexpr int	kDefaultKnobSectionHeight = 64

static constexpr int	kDefaultSliderWidth = 24

static constexpr int	kDefaultTextWidth = 80

static constexpr int	kDefaultTextHeight = 24

static constexpr int	kDefaultWidgetMargin = 6

static constexpr float	kDefaultWidgetFillFade = 0.3f

static constexpr float	kDefaultWidgetLineWidth = 4.0f

static constexpr float	kDefaultWidgetFillCenter = 0.0f

Additional Inherited Members
Protected Member Functions inherited from SynthSection
void	setSliderHasHzAlternateDisplay (SynthSlider *slider)

void	setSidewaysHeading (bool sideways)

void	addToggleButton (ToggleButton *button, bool show)

void	addButton (OpenGlToggleButton *button, bool show=true)

void	addButton (OpenGlShapeButton *button, bool show=true)

void	addSlider (SynthSlider *slider, bool show=true, bool listen=true)

void	addOpenGlComponent (OpenGlComponent *open_gl_component, bool to_beginning=false)

void	setActivator (SynthButton *activator)

void	createOffOverlay ()

void	setPresetSelector (PresetSelector *preset_selector, bool half=false)

void	paintJointControlSliderBackground (Graphics &g, int x, int y, int width, int height)

void	paintJointControlBackground (Graphics &g, int x, int y, int width, int height)

void	paintJointControl (Graphics &g, int x, int y, int width, int height, const std::string &name)

void	placeJointControls (int x, int y, int width, int height, SynthSlider left, SynthSlider right, Component *widget=nullptr)

void	placeTempoControls (int x, int y, int width, int height, SynthSlider tempo, SynthSlider sync)

void	placeRotaryOption (Component option, SynthSlider rotary)

void	placeKnobsInArea (Rectangle< int > area, std::vector< Component * > knobs)

void	lockCriticalSection ()

void	unlockCriticalSection ()

Rectangle< int >	getPresetBrowserBounds ()

int	getTitleTextRight ()

Rectangle< int >	getPowerButtonBounds ()

Rectangle< int >	getTitleBounds ()

float	getDisplayScale () const

virtual int	getPixelMultiple () const

Protected Attributes inherited from SynthSection
std::map< Skin::ValueId, float >	value_lookup_

std::vector< SynthSection * >	sub_sections_

std::vector< OpenGlComponent * >	open_gl_components_

std::map< std::string, SynthSlider * >	slider_lookup_

std::map< std::string, Button * >	button_lookup_

std::map< std::string, ModulationButton * >	modulation_buttons_

std::map< std::string, SynthSlider * >	all_sliders_

std::map< std::string, ToggleButton * >	all_buttons_

std::map< std::string, ModulationButton * >	all_modulation_buttons_

const SynthSection *	parent_

SynthButton *	activator_

PresetSelector *	preset_selector_

bool	preset_selector_half_width_

std::unique_ptr< OffOverlay >	off_overlay_

Skin::SectionOverride	skin_override_

float	size_ratio_

bool	active_

bool	sideways_heading_

Detailed Description

A UI component displaying a list of presets with sorting, filtering, and favorite management.

The PresetList shows presets in a table-like layout with columns for name, style, author, date, and a favorite star. Users can filter, sort, and rename presets, as well as toggle favorites and select presets.

Member Enumeration Documentation

◆ Column

enum PresetList::Column

Columns in the preset list.

Enumerator
kNone
kStar
kName
kStyle
kAuthor
kDate
kNumColumns

◆ MenuOptions

enum PresetList::MenuOptions

Context menu actions for a selected preset.

Enumerator
kCancel
kOpenFileLocation
kRename
kDelete
kNumMenuOptions

Constructor & Destructor Documentation

◆ PresetList()

PresetList::PresetList ( )

Constructs a PresetList.

Member Function Documentation

◆ addListener()

void PresetList::addListener ( Listener * listener )

inline

Adds a listener for preset events.

Parameters

listener The listener to add.

◆ destroyOpenGlComponents()

void PresetList::destroyOpenGlComponents ( OpenGlWrapper & open_gl )

overridevirtual

Destroys all OpenGL components in this section and sub-sections.

Parameters

open_gl The OpenGlWrapper context.

Reimplemented from SynthSection.

◆ filter()

void PresetList::filter	(	String	filter_string,
		const std::set< std::string > &	styles )

Filters the displayed presets by name, author, and styles.

Parameters

filter_string	The string to filter by.
styles	A set of styles to include.

◆ finishRename()

void PresetList::finishRename ( )

Finalizes a preset rename operation.

◆ getRowFromPosition()

int PresetList::getRowFromPosition ( float mouse_position )

Converts a mouse Y position into a row index.

Parameters

mouse_position The Y coordinate.

Returns: The row index, or -1 if out of range.

◆ getRowHeight()

int PresetList::getRowHeight ( )

inline

Gets the row height in pixels.

Returns: The scaled row height.

◆ getScrollableRange()

int PresetList::getScrollableRange ( )

Gets the scrollable height of the presets.

Returns: The total scrollable range in pixels.

◆ getSelectedIndex()

int PresetList::getSelectedIndex ( )

Gets the index of the currently selected preset.

Returns: The index of the selected preset, or -1 if none selected.

◆ initOpenGlComponents()

void PresetList::initOpenGlComponents ( OpenGlWrapper & open_gl )

overridevirtual

Initializes all OpenGL components in this section and sub-sections.

Parameters

open_gl The OpenGlWrapper context.

Reimplemented from SynthSection.

◆ leftClick()

void PresetList::leftClick ( const MouseEvent & e )

Called on left-click to select, rename, or favorite a preset.

Parameters

e	The mouse event.

◆ menuClick()

void PresetList::menuClick ( const MouseEvent & e )

Called on right-click to show a context menu.

Parameters

e	The mouse event.

◆ mouseDown()

void PresetList::mouseDown ( const MouseEvent & e )

override

◆ mouseExit()

void PresetList::mouseExit ( const MouseEvent & e )

override

◆ mouseMove()

void PresetList::mouseMove ( const MouseEvent & e )

override

◆ mouseWheelMove()

void PresetList::mouseWheelMove	(	const MouseEvent &	e,
		const MouseWheelDetails &	wheel )

override

◆ paintBackground()

void PresetList::paintBackground ( Graphics & g )

overridevirtual

Paints the background of the section. Calls paintContainer, heading, knobs, children.

Parameters

g	The Graphics context.

Reimplemented from SynthSection.

◆ paintBackgroundShadow()

void PresetList::paintBackgroundShadow ( Graphics & g )

inlineoverridevirtual

Stub for painting background shadows. Overridden by subclasses if needed.

Parameters

g	The Graphics context.

Reimplemented from SynthSection.

◆ redoCache()

void PresetList::redoCache ( )

Updates the cached images for rows after sorting or filtering.

◆ reloadPresets()

void PresetList::reloadPresets ( )

Reloads the currently displayed presets from disk.

◆ renderOpenGlComponents()

void PresetList::renderOpenGlComponents	(	OpenGlWrapper &	open_gl,
		bool	animate )

overridevirtual

Renders all OpenGL components in this section and sub-sections.

Parameters

open_gl	The OpenGlWrapper context.
animate	True if animation is desired.

Reimplemented from SynthSection.

◆ resized()

void PresetList::resized ( )

overridevirtual

Called when the component is resized. Arranges layout of child components.

Reimplemented from SynthSection.

◆ respondToMenuCallback()

void PresetList::respondToMenuCallback ( int result )

Handles actions from the preset context menu.

Parameters

result The selected menu option ID.

◆ scrollBarMoved()

void PresetList::scrollBarMoved	(	ScrollBar *	scroll_bar,
		double	range_start )

override

◆ setCurrentFolder()

void PresetList::setCurrentFolder ( const File & folder )

inline

Sets the current folder to display presets from.

Parameters

folder The directory containing presets.

◆ setPresets()

void PresetList::setPresets ( Array< File > presets )

Sets the array of presets to display.

Parameters

presets An array of File objects representing presets.

◆ setScrollBarRange()

void PresetList::setScrollBarRange ( )

◆ shiftSelectedPreset()

void PresetList::shiftSelectedPreset ( int indices )

Moves the selected preset up or down by a number of indices.

Parameters

indices The number of steps to move.

◆ textEditorEscapeKeyPressed()

void PresetList::textEditorEscapeKeyPressed ( TextEditor & editor )

override

◆ textEditorFocusLost()

void PresetList::textEditorFocusLost ( TextEditor & text_editor )

override

◆ textEditorReturnKeyPressed()

void PresetList::textEditorReturnKeyPressed ( TextEditor & text_editor )

override

Member Data Documentation

◆ kAuthorWidthPercent

float PresetList::kAuthorWidthPercent = 0.25f

staticconstexpr

◆ kDateWidthPercent

float PresetList::kDateWidthPercent = 0.18f

staticconstexpr

◆ kNameWidthPercent

float PresetList::kNameWidthPercent = 0.35f

staticconstexpr

◆ kNumCachedRows

int PresetList::kNumCachedRows = 50

staticconstexpr

◆ kRowSizeHeightPercent

float PresetList::kRowSizeHeightPercent = 0.04f

staticconstexpr

◆ kScrollSensitivity

float PresetList::kScrollSensitivity = 200.0f

staticconstexpr

◆ kStarWidthPercent

float PresetList::kStarWidthPercent = 0.04f

staticconstexpr

◆ kStyleWidthPercent

float PresetList::kStyleWidthPercent = 0.18f

staticconstexpr

The documentation for this class was generated from the following files:

/Users/davidvogel/repos/VitalHelp/src/interface/editor_sections/preset_browser.h
/Users/davidvogel/repos/VitalHelp/src/interface/editor_sections/preset_browser.cpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Column

◆ MenuOptions

Constructor & Destructor Documentation

◆ PresetList()

Member Function Documentation

◆ addListener()

◆ destroyOpenGlComponents()

◆ filter()

◆ finishRename()

◆ getRowFromPosition()

◆ getRowHeight()

◆ getScrollableRange()

◆ getSelectedIndex()

◆ initOpenGlComponents()

◆ leftClick()

◆ menuClick()

◆ mouseDown()

◆ mouseExit()

◆ mouseMove()

◆ mouseWheelMove()

◆ paintBackground()

◆ paintBackgroundShadow()

◆ redoCache()

◆ reloadPresets()

◆ renderOpenGlComponents()

◆ resized()

◆ respondToMenuCallback()

◆ scrollBarMoved()

◆ setCurrentFolder()

◆ setPresets()

◆ setScrollBarRange()

◆ shiftSelectedPreset()

◆ textEditorEscapeKeyPressed()

◆ textEditorFocusLost()

◆ textEditorReturnKeyPressed()

Member Data Documentation

◆ kAuthorWidthPercent

◆ kDateWidthPercent

◆ kNameWidthPercent

◆ kNumCachedRows

◆ kRowSizeHeightPercent

◆ kScrollSensitivity

◆ kStarWidthPercent

◆ kStyleWidthPercent