A UI component that displays a list of selectable string options. More...

#include <ListBox.h>

Inheritance diagram for ListBox:

Public Member Functions
	ListBox ()
	Constructs an empty ListBox component.
virtual	~ListBox ()
	Destructor.
void	setColorsListType ()
void	clear ()
void	addItem (const wstring &text, COLORREF color=Theme::BackgroundColor)
	Adds to the list of selectable options.
void	setSelectedItem (const wstring &text)
	Sets the currently selected item by text.
wstring	getSelectedItem ()
	Retrieves the currently selected item text.
void	onPaint (Graphics *g) override
	Called to paint the component's client area.
void	onWindowResized () override
	Called when the component's window is resized.
void	onArrowUp (BOOL shiftPressed, BOOL ctrlPressed) override
void	onArrowDown (BOOL shiftPressed, BOOL ctrlPressed) override
void	onPageUp (BOOL shiftPressed, BOOL ctrlPressed) override
void	onPageDown (BOOL shiftPressed, BOOL ctrlPressed) override
void	onKeyHome (BOOL shiftPressed, BOOL ctrlPressed) override
void	onKeyEnd (BOOL shiftPressed, BOOL ctrlPressed) override
void	onMousePressed (WinHandle hWnd, int x, int y, int clickCount, BOOL shiftPressed, BOOL ctrlPressed) override
	Called when the mouse is pressed within the component.
BOOL	onMouseWheel (WinHandle hWnd, int x, int y, int delta) override
	Called when the mouse wheel is used over the component.
void	onFocusGained () override
	Called when the component gains keyboard focus.
void	onFocusLost () override
	Called when the component loses keyboard focus.
BOOL	getScrollingInfo (__int64 &scrollMin, __int64 &scrollMax, __int64 &pageSize) override
	Provides scrolling information if supported.
void	setScrollbarTopOffset (__int64 firstVisibleRow) override
	Sets the scrollbar's top offset.
void	addSelectionChangedListener (SelectionChangeListener *l)
void	addItemDoubleClickedListener (RowDoubleClickListener *l)
Public Member Functions inherited from Component
	Component ()
	Constructs a new Component instance.
virtual	~Component ()
	Virtual destructor.
long	getId ()
	Gets the unique ID assigned to this component.
void	setParent (Component *parent)
Component *	getParent ()
wstring	getComponentType ()
	Gets the component type string.
BOOL	isWindowCreated ()
	Returns whether the native window has been created.
WinHandle	getWindowHandle ()
	Returns the native WinHandle for this component.
int	createComponent (WinHandle hParent, Bounds rect, long nCmd=-1, BOOL isVisible=TRUE)
	Creates the component's native window as a child of hParent.
void	setFont (long fontSize, BOOL isBold=FALSE, BOOL isItalic=FALSE, BOOL isUnderlined=FALSE, const wstring &fontName=L"Arial")
	Sets the font for the component.
void	showBorder (BOOL bShow=TRUE)
void	setEnabled (BOOL bEnable=TRUE)
	Enables or disables the component.
void	setVisible (BOOL bShow=TRUE)
	Shows or hides the component.
void	GetClientRect (Bounds &rect)
void	GetWindowRect (Bounds &rect)
void	moveWindow (long x, long y, long width, long height, BOOL bRedraw=TRUE)
	Moves and resizes the component window.
void	reconfigureScrollBar ()
	Forces the component to recalculate the scrollbar info.
void	setMouseWheelDelta (int delta)
	Sets the accumulated mouse wheel delta.
int	getMouseWheelDelta ()
	Gets the current mouse wheel delta.
virtual int	getMinimumHeight ()
	Returns the minimum height the component can have.
virtual int	getPreferredHeight ()
	Returns the preferred height of the component.
void	repaint (WinHandle hWnd=NULL)
	Requests the component to repaint itself.
void	clearQueuedPaintRequest ()
	clears the queued paint request. This function should only be called internally from the library.
virtual void	onWindowMoved ()
	Called when the component's window is moved.
virtual void	onAction (WinHandle hTarget, long actionId, const ProcParams &procParams)
	Called when an action occurs on the component.
virtual void	onSelectionChanged (WinHandle hTarget, int itemIndex, const wstring &itemText, BOOL itemChecked, const ProcParams &procParams)
	Called when the selection changes.
virtual void	onDataChanged (WinHandle hTarget, const wstring &newValue, const ProcParams &procParams)
	Called when data changes in the component.
virtual BOOL	onHorzScroll (WinHandle hTarget, const ProcParams &procParams)
	Called on horizontal scroll events.
virtual BOOL	onDrawMeasureItem (LPMEASUREITEMSTRUCT dis, const ProcParams &procParams)
	Called when measuring an item for owner-draw controls.
virtual BOOL	onDrawItem (LPDRAWITEMSTRUCT dis, const ProcParams &procParams)
	Called when drawing an item for owner-draw controls.
virtual void	onMouseReleased (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
	Called when the mouse button is released within the component.
virtual void	onMouseRightClicked (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
	Called when the right mouse button is clicked within the component.
virtual void	onMouseMoved (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
	Called when the mouse is moved within the component.
virtual void	onArrowLeft (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onArrowRight (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyInsert (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyDelete (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyBackSpace (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyTyped (wchar_t ch, BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyTab (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyEnter (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF1 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF2 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF3 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF4 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF5 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF6 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF7 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF8 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF9 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF10 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF11 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyF12 (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onTimer (unsigned int timerId)
	Called on timer events.
void	updateScrollbarTopOffset (__int64 firstVisibleRow)
	Updates the scrollbar's top offset based on the current first visible row.

Protected Member Functions
BOOL	getCreateWindowOptions (wstring &title, UINT &widownStyles, wstring &wndClassName, BOOL &isCustomWndProc)
	Provides native window creation options for the ListBox control.
void	windowCreated ()
	Called once the native window has been created.
Protected Member Functions inherited from Component
long	getActionId ()
	Returns the component's action command ID.
void	doNotSubclass ()
	Marks this component's native window to avoid subclassing.
void	startTimer (unsigned int timerId, unsigned int milliseconds)
	Starts a timer with the given ID and interval.
void	stopTimer (unsigned int timerId)
	Stops the timer identified by timerId.
void	protectedAddDataChangedListener (DataChangeListener *l)
	Adds a data change listener.
void	protectedAddSelectionChangedListener (SelectionChangeListener *l)
	Adds a selection change listener.
void	protectedAddActionListener (ActionListener *l)
	Adds an action listener.
void	protectedAddItemDoubleClickedListener (RowDoubleClickListener *l)
	Adds a row double-click listener.
void	protectedFireDataChangedEvent (const wstring &oldValue, const wstring &newValue)
	Fires a data changed event to registered listeners.
void	protectedFireSelectionChangedEvent (long selectionIndex=-1, const wstring &selectionValue=L"", BOOL checked=FALSE)
	Fires a selection changed event to registered listeners.
void	protectedFireActionEvent (long actionId=-1, const wstring &actionName=L"")
	Fires an action event to registered listeners.
void	protectedFireItemDoubleClickedEvent (__int64 rowIndex)
	Fires a row double-click event to registered listeners.

Additional Inherited Members
Protected Attributes inherited from Component
WinHandle	_hWnd
	Handle to the native window associated with this component.
wstring	_componentType
	String representing the component type (e.g., "Button", "ComboBox").
BOOL	_showBorder

Detailed Description

A UI component that displays a list of selectable string options.

The ListBox allows the user to select an item from a list. It supports selection change notifications via listeners.

Constructor & Destructor Documentation

◆ ListBox()

ListBox::ListBox ( )

Constructs an empty ListBox component.

◆ ~ListBox()

virtual ListBox::~ListBox ( )

virtual

Destructor.

Member Function Documentation

◆ addItem()

void ListBox::addItem	(	const wstring &	text,
		COLORREF	color = Theme::BackgroundColor )

Adds to the list of selectable options.

Parameters

text	The text of the item
color	The color value of the item in case the setColorsListType is called

◆ addItemDoubleClickedListener()

void ListBox::addItemDoubleClickedListener ( RowDoubleClickListener * l )

◆ addSelectionChangedListener()

void ListBox::addSelectionChangedListener ( SelectionChangeListener * l )

◆ clear()

void ListBox::clear ( )

◆ getCreateWindowOptions()

BOOL ListBox::getCreateWindowOptions	(	wstring &	title,
		UINT &	widownStyles,
		wstring &	wndClassName,
		BOOL &	isCustomWndProc )

protectedvirtual

Provides native window creation options for the ListBox control.

Parameters

title	Window title (usually unused for list boxes).
widownStyles	Window styles flags.
wndClassName	Window class name.
isCustomWndProc	Whether to use a custom window procedure.

Returns: TRUE if options successfully provided.

Implements Component.

◆ getScrollingInfo()

BOOL ListBox::getScrollingInfo	(	__int64 &	scrollMin,
		__int64 &	scrollMax,
		__int64 &	pageSize )

overridevirtual

Provides scrolling information if supported.

Parameters

scrollMin	Output minimum scroll value.
scrollMax	Output maximum scroll value.
pageSize	Output page size.

Returns: TRUE if scrollbar is applicable and info is provided, FALSE otherwise.

Reimplemented from Component.

◆ getSelectedItem()

wstring ListBox::getSelectedItem ( )

Retrieves the currently selected item text.

Returns: The selected item string.

◆ onArrowDown()

void ListBox::onArrowDown	(	BOOL	shiftPressed,
		BOOL	ctrlPressed )

overridevirtual

Reimplemented from Component.

◆ onArrowUp()

void ListBox::onArrowUp	(	BOOL	shiftPressed,
		BOOL	ctrlPressed )

overridevirtual

Reimplemented from Component.

◆ onFocusGained()

void ListBox::onFocusGained ( )

overridevirtual

Called when the component gains keyboard focus.

Reimplemented from Component.

◆ onFocusLost()

void ListBox::onFocusLost ( )

overridevirtual

Called when the component loses keyboard focus.

Reimplemented from Component.

◆ onKeyEnd()

void ListBox::onKeyEnd	(	BOOL	shiftPressed,
		BOOL	ctrlPressed )

overridevirtual

Reimplemented from Component.

◆ onKeyHome()

void ListBox::onKeyHome	(	BOOL	shiftPressed,
		BOOL	ctrlPressed )

overridevirtual

Reimplemented from Component.

◆ onMousePressed()

void ListBox::onMousePressed	(	WinHandle	hWnd,
		int	x,
		int	y,
		int	clickCount,
		BOOL	shiftPressed,
		BOOL	ctrlPressed )

overridevirtual

Called when the mouse is pressed within the component.

Reimplemented from Component.

◆ onMouseWheel()

BOOL ListBox::onMouseWheel	(	WinHandle	hWnd,
		int	x,
		int	y,
		int	delta )

overridevirtual

Called when the mouse wheel is used over the component.

Parameters

hWnd	Handle to the window receiving the event.
x	X coordinate of the mouse.
y	Y coordinate of the mouse.
delta	Mouse wheel delta.

Returns: TRUE if the event was handled, FALSE otherwise.

Reimplemented from Component.

◆ onPageDown()

void ListBox::onPageDown	(	BOOL	shiftPressed,
		BOOL	ctrlPressed )

overridevirtual

Reimplemented from Component.

◆ onPageUp()

void ListBox::onPageUp	(	BOOL	shiftPressed,
		BOOL	ctrlPressed )

overridevirtual

Reimplemented from Component.

◆ onPaint()

void ListBox::onPaint ( Graphics * g )

overridevirtual

Called to paint the component's client area.

Reimplemented from Component.

◆ onWindowResized()

void ListBox::onWindowResized ( )

overridevirtual

Called when the component's window is resized.

Reimplemented from Component.

◆ setColorsListType()

void ListBox::setColorsListType ( )

◆ setScrollbarTopOffset()

void ListBox::setScrollbarTopOffset ( __int64 firstVisibleRow )

overridevirtual

Sets the scrollbar's top offset.

Parameters

firstVisibleRow The first visible row index.

Reimplemented from Component.

◆ setSelectedItem()

void ListBox::setSelectedItem ( const wstring & text )

Sets the currently selected item by text.

Parameters

text	The item to select.

◆ windowCreated()

void ListBox::windowCreated ( )

protectedvirtual

Called once the native window has been created.

Implements Component.

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

ListBox.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ListBox()

◆ ~ListBox()

Member Function Documentation

◆ addItem()

◆ addItemDoubleClickedListener()

◆ addSelectionChangedListener()

◆ clear()

◆ getCreateWindowOptions()

◆ getScrollingInfo()

◆ getSelectedItem()

◆ onArrowDown()

◆ onArrowUp()

◆ onFocusGained()

◆ onFocusLost()

◆ onKeyEnd()

◆ onKeyHome()

◆ onMousePressed()

◆ onMouseWheel()

◆ onPageDown()

◆ onPageUp()

◆ onPaint()

◆ onWindowResized()

◆ setColorsListType()

◆ setScrollbarTopOffset()

◆ setSelectedItem()

◆ windowCreated()