A star rating UI component that supports whole and half stars. More...

#include <Rating.h>

Inheritance diagram for Rating:

Public Member Functions
	Rating ()
	Constructs a new Rating component.
virtual	~Rating ()
	Destructor for the Rating component.
int	getPreferredHeight ()
	Returns the preferred height.
void	setRating (int rating, BOOL includesHalf)
	Sets the current rating and whether half-star ratings are allowed.
void	getRating (int &rating, BOOL &includesHalf)
	Gets the current rating and half-star status.
void	onPaint (Graphics *g)
	Paints the rating control.
void	onMousePressed (WinHandle hWnd, int x, int y, int clickCount, BOOL shiftPressed, BOOL ctrlPressed)
	Handles mouse press events on the control.
void	onMouseMoved (WinHandle hWnd, int x, int y, BOOL shiftPressed, BOOL ctrlPressed)
	Handles mouse move events over the control.
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.
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	onWindowResized ()
	Called when the component's window is resized.
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 BOOL	onMouseWheel (WinHandle hWnd, int x, int y, int delta)
	Called when the mouse wheel is used over the component.
virtual void	onArrowLeft (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onArrowRight (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onArrowUp (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onArrowDown (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onPageUp (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onPageDown (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyHome (BOOL shiftPressed, BOOL ctrlPressed)
virtual void	onKeyEnd (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	onFocusGained ()
	Called when the component gains keyboard focus.
virtual void	onFocusLost ()
	Called when the component loses keyboard focus.
virtual void	onTimer (unsigned int timerId)
	Called on timer events.
virtual BOOL	getScrollingInfo (__int64 &scrollMin, __int64 &scrollMax, __int64 &pageSize)
	Provides scrolling information if supported.
virtual void	setScrollbarTopOffset (__int64 firstVisibleRow)
	Sets the scrollbar's top offset.
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)
	Gets options for creating the window.
void	windowCreated ()
	Called when the window is 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 star rating UI component that supports whole and half stars.

Constructor & Destructor Documentation

◆ Rating()

Rating::Rating ( )

Constructs a new Rating component.

◆ ~Rating()

virtual Rating::~Rating ( )

virtual

Destructor for the Rating component.

Member Function Documentation

◆ getCreateWindowOptions()

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

protectedvirtual

Gets options for creating the window.

Implements Component.

◆ getPreferredHeight()

int Rating::getPreferredHeight ( )

virtual

Returns the preferred height.

Reimplemented from Component.

◆ getRating()

void Rating::getRating	(	int &	rating,
		BOOL &	includesHalf )

Gets the current rating and half-star status.

Parameters

rating	Output parameter for the current rating.
includesHalf	Output parameter indicating if half-star ratings are enabled.

◆ onMouseMoved()

void Rating::onMouseMoved	(	WinHandle	hWnd,
		int	x,
		int	y,
		BOOL	shiftPressed,
		BOOL	ctrlPressed )

virtual

Handles mouse move events over the control.

Parameters

hWnd	Handle to the window.
x	X coordinate of the mouse.
y	Y coordinate of the mouse.
shiftPressed	TRUE if Shift key is pressed.
ctrlPressed	TRUE if Ctrl key is pressed.

Reimplemented from Component.

◆ onMousePressed()

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

virtual

Handles mouse press events on the control.

Parameters

hWnd	Handle to the window.
x	X coordinate of the mouse click.
y	Y coordinate of the mouse click.
clickCount	Number of clicks.
shiftPressed	TRUE if Shift key was pressed.
ctrlPressed	TRUE if Ctrl key was pressed.

Reimplemented from Component.

◆ onPaint()

void Rating::onPaint ( Graphics * g )

virtual

Paints the rating control.

Parameters

hDC	Device context handle for painting.

Reimplemented from Component.

◆ setRating()

void Rating::setRating	(	int	rating,
		BOOL	includesHalf )

Sets the current rating and whether half-star ratings are allowed.

Parameters

rating	Number of stars (can include halves if enabled).
includesHalf	TRUE if half-star ratings are enabled.

◆ windowCreated()

void Rating::windowCreated ( )

protectedvirtual

Called when the window is created.

Implements Component.

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

Rating.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Rating()

◆ ~Rating()

Member Function Documentation

◆ getCreateWindowOptions()

◆ getPreferredHeight()

◆ getRating()

◆ onMouseMoved()

◆ onMousePressed()

◆ onPaint()

◆ setRating()

◆ windowCreated()