libaria_widget_listwheel.h

Microchip Technology Inc.

File Name

Description

Module for Microchip Graphics Library - Aria User Interface Library

This module implements list wheel (drawing-style list box) widget functions.

Enumerations

	Name	Description
	laListWheelIndicatorFill_t	Indicates the fill type for the listwheel indicator area.
	laListWheelZoomEffects_t	Indicates the zoom effects for the list wheel items.
	laListWheelIndicatorFill	Indicates the fill type for the listwheel indicator area.
	laListWheelZoomEffects	Indicates the zoom effects for the list wheel items.

Functions

	Name	Description
	laListWheelWidget_AppendItem	Appends a new item entry to the list. The initial value of the item will be empty.
	laListWheelWidget_GetAlignment	Gets the horizontal alignment for the list widget
	laListWheelWidget_GetAutoHideWheel	Returns the list wheel auto hide setting
	laListWheelWidget_GetFlickInitSpeed	Returns the flick init speed for the wheel.
	laListWheelWidget_GetIconMargin	Gets the icon margin value for the list wheel widget
	laListWheelWidget_GetIconPosition	Sets the icon position for the list wheel widget.
	laListWheelWidget_GetIndicatorArea	Returns the spacing for the selected item indicator bars.
	laListWheelWidget_GetIndicatorFill	Gets the indicator area fill type
	laListWheelWidget_GetItemCount	Gets the number of items currently contained in the list
	laListWheelWidget_GetItemIcon	Gets the pointer to the image asset for the icon for the item at the given index.
	laListWheelWidget_GetItemText	Gets the text value for an item in the list.
	laListWheelWidget_GetMaxMomentum	Returns the maximum momentum value for the wheel.
	laListWheelWidget_GetMomentumFalloffRate	Returns the momentum falloff rate for the wheel.
	laListWheelWidget_GetRotationUpdateRate	Returns the wheel rotation update rate.
	laListWheelWidget_GetSelectedItem	Returns the index of the currently selected item.
	laListWheelWidget_GetSelectedItemChangedEventCallback	Gets the callback for the item selected changed event
	laListWheelWidget_GetShaded	Returns true if the list is using gradient shading to illustrate depth
	laListWheelWidget_GetShowIndicators	Returns true if the list is displaying its selected item indicators
	laListWheelWidget_GetVisibleItemCount	Returns the list's visible item count
	laListWheelWidget_GetZoomEffects	Gets the list wheel zoom effect
	laListWheelWidget_InsertItem	Attempts to insert a new item at the desired index. Existing items at idx or greater will be shuffled one index to the right.
	laListWheelWidget_New	Allocates memory for a new widget of this type. The application is responsible for the managment of this memory until the widget is added to a widget tree.
	laListWheelWidget_RemoveAllItems	Attempts to remove all items from the list.
	laListWheelWidget_RemoveItem	Attempts to remove an item from the list.
	laListWheelWidget_SelectNextItem	Attempts to move the selected item index to the next item in the list.
	laListWheelWidget_SelectPreviousItem	Attempts to move the selected item index to the previous item in the list.
	laListWheelWidget_SetAlignment	Sets the horizontal alignment mode for the list widget.
	laListWheelWidget_SetAutoHideWheel	Sets the list wheel to auto hide when not active
	laListWheelWidget_SetFlickInitSpeed	Configures the flick init speed for the list wheel
	laListWheelWidget_SetIconMargin	Sets the icon margin value for the list widget.
	laListWheelWidget_SetIconPosition	Sets the icon position for the list wheel widget
	laListWheelWidget_SetIndicatorArea	Configures the display area for the list selection indicator bars
	laListWheelWidget_SetIndicatorFill	Sets the indicator fill type
	laListWheelWidget_SetItemIcon	Sets the icon pointer for a given index.
	laListWheelWidget_SetItemText	Sets the text value for an item in the list.
	laListWheelWidget_SetMaxMomentum	Configures the maximum momentum value for the wheel
	laListWheelWidget_SetMomentumFalloffRate	Configures the momentum falloff rate for the wheel
	laListWheelWidget_SetRotationUpdateRate	Configures the rotation update rate for a wheel
	laListWheelWidget_SetSelectedItem	Attempts to set the selectedi tem index
	laListWheelWidget_SetSelectedItemChangedEventCallback
	laListWheelWidget_SetShaded	Configures the list to use gradient or flat background shading
	laListWheelWidget_SetShowIndicators	Configures the list to display the selected item indicator bars
	laListWheelWidget_SetVisibleItemCount	Sets the number of visible items in the list. Must be greater than or equal to three and must be an odd number.
	laListWheelWidget_SetZoomEffects	Sets the list wheel zoom effect

Structures

	Name	Description
	laListWheelItem_t	Implementation of a list wheel widget item struct
	laListWheelWidget_t	Implementation of a list wheel widget struct
	laListWheelItem	Implementation of a list wheel widget item struct
	laListWheelWidget	Implementation of a list wheel widget struct

Types

	Name	Description
	laListWheelWidget_SelectedItemChangedEvent	Selected item changed event function callback type

MPLAB® Harmony Graphics Suite > Graphics Library > Aria Graphics Library > Files > libaria_widget_listwheel.h

MPLAB® Harmony Graphics Suite

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support