libaria_context.h

Microchip Technology Inc.

File Name

libaria_context.h

Description

Module for Microchip Graphics Library - Aria User Interface Library

Enumerations

	Name	Description
	laContextFrameState_t	Possible values for context frame state.
	laContextUpdateState_t	Possible values for context update state.
	laContextFrameState	Possible values for context frame state.
	laContextUpdateState	Possible values for context update state.

Functions

	Name	Description
	laContext_AddScreen	Add screen to the list of screens in the current context
	laContext_Create	Creates an instance of the Aria user interface library
	laContext_Destroy	Destroys an Aria instance
	laContext_GetActive	Returns the current active context.
	laContext_GetActiveScreen	Returns the active screen of the current context
	laContext_GetActiveScreenIndex	Return the index of the active screen
	laContext_GetColorMode	Returns the color mode of the current context
	laContext_GetDefaultScheme	Returns the pointer to the default scheme of the current context
	laContext_GetEditWidget	Gets the widget that is currently recieving all widget edit events.
	laContext_GetFocusWidget	Return a pointer to the widget in focus
	laContext_GetPremptionLevel	Returns the preemption level for the screen
	laContext_GetScreenRect	Returns the display rectangle structure of the physical display
	laContext_GetStringLanguage	Returns the language index of the current context
	laContext_GetStringTable	Get a pointer to the GFXU_StringTableAsset structure that maintains the strings, associated fonts, etc
	laContext_HideActiveScreen	Hide the active screen
	laContext_IsDrawing	Indicates if any layers of the active screen are currently drawing a frame.
	laContext_IsLayerDrawing	Indicates if the layer at the given index of the active screen is currently drawing.
	laContext_RedrawAll	Forces the library to redraw the currently active screen in its entirety.
	laContext_RemoveScreen	Remove the specified screen from the list of screens in the current context
	laContext_SetActive	Make the specified context active
	laContext_SetActiveScreen	Change the active screen to the one specified by the index argument
	laContext_SetActiveScreenChangedCallback	Set the callback function pointer when the screen change event occurs
	laContext_SetEditWidget	Sets the currently active edit widget.
	laContext_SetFocusWidget	Set into focus the widget specified as the argument
	laContext_SetLanguageChangedCallback	Set the callback function pointer when the language change event occurs
	laContext_SetPreemptionLevel	Set the preemption level to the specified value
	laContext_SetPreprocessAssetStateChangedCallback	Set the callback function pointer when the preprocess state change event occurs
	laContext_SetStringLanguage	Set the language index of the current context
	laContext_SetStringTable	Set the StringTable pointer to the specified new StringTableAsset structure
	laContext_Update	Runs the update loop for a library instance.

Structures

	Name	Description
	laContext_t	An instance of the Aria user interface library.

Types

	Name	Description
	GFXU_StringTableAsset	This is type GFXU_StringTableAsset.
	laContext_ActiveScreenChangedCallback_FnPtr	Callback pointer for the active screen change notification.
	laContext_LanguageChangedCallback_FnPtr	Callback pointer for when the language change event occurs.
	laContext_PreprocessAssetsStateChangedCallback_FnPtr	Callback pointer for when asset pre-processing is about to changes state
	laContextPreprocessAssetsState	Possible values for asset preprocess state.

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

MPLAB® Harmony Graphics Suite

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support