libaria_widget

Microchip Technology Inc.

File Name

libaria_widget_list.h

Description

Module for Microchip Graphics Library - Aria User Interface Library

This module implements list box widget functions.

Enumerations

	Name	Description
	laListWidget_SelectionMode_t	Defines the list selection modes
	laListWidget_SelectionMode	Defines the list selection modes

Functions

	Name	Description
	laListWidget_AppendItem	Appends a new item entry to the list. The initial value of the item will be empty.
	laListWidget_DeselectAll	Attempts to set all item states as not selected.
	laListWidget_GetAlignment	Gets the horizontal alignment for the list widget
	laListWidget_GetAllowEmptySelection	Returns true of the list allows an empty selection set
	laListWidget_GetFirstSelectedItem	Returns the lowest selected item index.
	laListWidget_GetIconMargin	Gets the icon margin value for the list widget
	laListWidget_GetIconPosition	Gets the icon position for the list
	laListWidget_GetItemCount	Gets the number of items currently contained in the list
	laListWidget_GetItemEnable	Returns the enable state of the item in the list widget
	laListWidget_GetItemIcon	Gets the pointer to the image asset for the icon for the item at the given index.
	laListWidget_GetItemSelected	Returns true if the item at the given index is currently selected.
	laListWidget_GetItemText	Gets the text value for an item in the list.
	laListWidget_GetLastSelectedItem	Returns the highest selected item index.
	laListWidget_GetSelectedItemChangedEventCallback	Gets the callback for the item selected changed event
	laListWidget_GetSelectionCount	Returns the number of selected items in the list.
	laListWidget_GetSelectionMode	Gets the selection mode for the list
	laListWidget_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.
	laListWidget_New	Allocates memory for and initializes 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.
	laListWidget_RemoveAllItems	Attempts to remove all items from the list.
	laListWidget_RemoveItem	Attempts to remove an item from the list.
	laListWidget_SelectAll	Attempts to set all item states to selected.
	laListWidget_SetAlignment	Sets the horizontal alignment mode for the list widget.
	laListWidget_SetAllowEmptySelection	Configures the list to allow an empty selection set.
	laListWidget_SetIconMargin	Sets the icon margin value for the list widget.
	laListWidget_SetIconPosition	Sets the icon position for the list widget
	laListWidget_SetItemEnable	Enables or disables an item in the list. A disable item becomes un-selectable.
	laListWidget_SetItemIcon	Sets the icon pointer for a given index.
	laListWidget_SetItemSelected	Attempts to set the item at idx as selected.
	laListWidget_SetItemText	Sets the text value for an item in the list.
	laListWidget_SetItemVisible
	laListWidget_SetSelectedItemChangedEventCallback	Sets the callback for the item selected changed event
	laListWidget_SetSelectionMode	Set the list selection mode
	laListWidget_ToggleItemSelected	Attempts to toggle the selected state of the item at idx.

Structures

	Name	Description
	laListItem_t	Defines a list item struct
	laListWidget_t	Defines the implementation of a list widget
	laListItem	Defines a list item struct
	laListWidget	Defines the implementation of a list widget

Types

	Name	Description
	laListWidget_SelectedItemChangedEvent	Selected item changed event function callback type

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

MPLAB® Harmony Graphics Suite

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support