libaria_widget.h

Microchip Technology Inc.

libaria_widget.h

Module for Microchip Graphics Library - Aria User Interface Library

This module implements top level widget control functions.

	Name	Description
	laBackgroundType_t	Specifies the different background types used for the widgets in the library
	laBorderType_t	Specifies the different border types used for the widgets in the library
	laWidgetDirtyState_t	Specifies the different dirty states the widget can be assigned
	laWidgetDrawState_t	Specifies the different draw states the widget can be assigned
	laWidgetOptimizationFlags_t	Specifies the different draw optimization flags for a widget
	laWidgetType_t	Specifies the different widget types used in the library
	laWidgetUpdateState_t	Specifies the different update states the widget can be assigned
	laBackgroundType	Specifies the different background types used for the widgets in the library
	laBorderType	Specifies the different border types used for the widgets in the library
	laWidgetDirtyState	Specifies the different dirty states the widget can be assigned
	laWidgetDrawState	Specifies the different draw states the widget can be assigned
	laWidgetOptimizationFlags	Specifies the different draw optimization flags for a widget
	laWidgetType	Specifies the different widget types used in the library
	laWidgetUpdateState	Specifies the different update states the widget can be assigned

	Name	Description
	laWidget_AddChild	Adds the child to the parent widget specified in the argument
	laWidget_Delete	Delete the widget object specified
	laWidget_DeleteAllDescendants	Deletes all of the descendants of the given widget.
	laWidget_GetAlphaAmount	Return the widget's global alpha amount
	laWidget_GetAlphaEnable	Return the alpha enable property of the widget
	laWidget_GetBackgroundType	Return the property value 'background type' associated with the widget object
	laWidget_GetBorderType	Return the border type associated with the widget object
	laWidget_GetChildAtIndex	Fetches the child at the specified index from the children list of the specified parent widget
	laWidget_GetChildCount	Returns the size of the children list of the specified parent widget
	laWidget_GetCornerRadius	Returns the corner radius of the widget
	laWidget_GetCumulativeAlphaAmount	Calculates the cumulative alpha amount for a hierarchy of widgets
	laWidget_GetCumulativeAlphaEnable	Determines if this or any ancestor widget has alpha enabled
	laWidget_GetEnabled	Returns the boolean value of the widget enabled property
	laWidget_GetHeight	Returns the widget rectangles height
	laWidget_GetIndexOfChild	Fetches the index of the child from the children list of the specified parent widget
	laWidget_GetMargin	Returns the margin value associated with the widget in the laMargin pointer
	laWidget_GetOptimizationFlags	Returns the optimization flags for the widget
	laWidget_GetScheme	Returns the scheme associated with the specified widget
	laWidget_GetVisible	Returns the boolean value of the widget visible property
	laWidget_GetWidth	Returns the widget rectangles width
	laWidget_GetX	Returns the widget rectangles upper left corner x-coordinate
	laWidget_GetY	Returns the widget rectangles upper left corner y-coordinate
	laWidget_HasFocus	Checks if the widget specified has focus in the current context
	laWidget_Invalidate	Invalidates the specified widget.
	laWidget_isOpaque	Returns true if the widget is considered opaque.
	laWidget_New	Create a new widget.
	laWidget_OverrideTouchDownEvent	Replace the TouchDownEvent callback for the widget with the new function pointer specified
	laWidget_OverrideTouchMovedEvent	Replace the TouchMovedEvent callback for the widget with the new function pointer specified
	laWidget_OverrideTouchUpEvent	Replace the TouchUpEvent callback for the widget with the new function pointer specified
	laWidget_RectToLayerSpace	Transforms a widget rectangle from local space to its root layer space.
	laWidget_RectToParentSpace	Returns the rectangle containing the parent of the widget specified
	laWidget_RectToScreenSpace	Transforms a widget rectangle from local space to screen space coordinates.
	laWidget_RemoveChild	Removes the child from the parent widget specified in the argument
	laWidget_Resize	Changes the widget size by the new defined width and height increments.
	laWidget_SetAlphaAmount	Set the widget's global alpha amount to the specified alpha amount
	laWidget_SetAlphaEnable	Set the alpha enable property of the widget with the boolean value specified
	laWidget_SetBackgroundType	Set the property value 'background type' associated with the widget object
	laWidget_SetBorderType	Set the border type associated with the widget object
	laWidget_SetCornerRadius	Sets the widget corner radius.
	laWidget_SetEnabled	Sets the boolean value of the widget enabled property
	laWidget_SetFocus	Set the widget into focus for the current context.
	laWidget_SetHeight	Sets the widget's height value
	laWidget_SetMargins	Set the margin value for left, right, top and bottom margins associated with the widget
	laWidget_SetOptimizationFlags	Sets the optimizations for a widget
	laWidget_SetParent	Sets the parent of the child widget to that specified in the argument list
	laWidget_SetPosition	Changes the widget position to the new defined x and y coordinates.
	laWidget_SetScheme	Sets the scheme variable for the specified widget
	laWidget_SetSize	Changes the widget size to the new defined width and height dimensions.
	laWidget_SetVisible	Sets the boolean value of the widget visible property
	laWidget_SetWidth	Sets the widget's width value
	laWidget_SetX	Sets the widget's x coordinate position
	laWidget_SetY	Sets the widget's y coordinate position
	laWidget_Translate	Changes the widget position by moving the widget by the defined x and y increments.

	Name	Description
	laWidget_t	Specifies Graphics widget structure to manage all properties and events associated with the widget
	laWidget	Specifies Graphics widget structure to manage all properties and events associated with the widget

	Name	Description
	laRectArray	Rectangle array definition