libaria_widget_circular

Microchip Technology Inc.

File Name

libaria_widget_circular_gauge.h

Description

Module for Microchip Graphics Library - Aria User Interface Library

This module implements circular gauge drawing widget functions.

Enumerations

	Name	Description
	laCircularGaugeWidgetArcType_t	Type of arc
	laCircularGaugeWidgetDir_t	Direction of the gauge
	laCircularGaugeWidgetLabelPosition_t	Direction of the gauge
	laCircularGaugeWidgetArcType	Type of arc
	laCircularGaugeWidgetDir	Direction of the gauge
	laCircularGaugeWidgetLabelPosition	Direction of the gauge

Functions

	Name	Description
	laCircularGaugeWidget_AddAngularArc	Adds an 'angular arc' in the gauge.
	laCircularGaugeWidget_AddMinorTickLabels	Adds minor tick labels in the gauge.
	laCircularGaugeWidget_AddMinorTicks	Adds minor ticks in the gauge.
	laCircularGaugeWidget_AddValueArc	Adds a 'value arc' in the gauge.
	laCircularGaugeWidget_DeleteArcs	Deletes all arcs in the gauge widget
	laCircularGaugeWidget_DeleteMinorTickLabels	Deletes all the minor tick labels in the gauge widget
	laCircularGaugeWidget_DeleteMinorTicks	Deletes all the minor ticks in the gauge widget
	laCircularGaugeWidget_GetCenterAngle	Returns the center angle of the circular gauge
	laCircularGaugeWidget_GetCenterCircleRadius	Returns radius of the center circle
	laCircularGaugeWidget_GetCenterCircleThickness	Returns thickness of the center circle
	laCircularGaugeWidget_GetCenterCircleVisible	Returns GFX_TRUE if the center circle is visible
	laCircularGaugeWidget_GetDirection	Returns the direction of the gauge.
	laCircularGaugeWidget_GetEndValue	Returns the end value of the gauge
	laCircularGaugeWidget_GetHandRadius	Returns the radius/length of the gauge hand in pixels
	laCircularGaugeWidget_GetHandVisible	Returns GFX_TRUE if the gauge hand is visible
	laCircularGaugeWidget_GetRadius	Gets the radius of a gauge widget
	laCircularGaugeWidget_GetStartAngle	Returns the start angle of the circular gauge
	laCircularGaugeWidget_GetStartValue	Returns the start value of the gauge
	laCircularGaugeWidget_GetTickLabelsVisible	Returns GFX_TRUE if the tick labels are visible
	laCircularGaugeWidget_GetTickLength	Returns the length of the ticks in the gauge in pixels
	laCircularGaugeWidget_GetTicksVisible	Returns GFX_TRUE if the ticks in the gauge are visible
	laCircularGaugeWidget_GetTickValue	Returns the tick increment value in the gauge
	laCircularGaugeWidget_GetValue	Returns the value of the gauge hand
	laCircularGaugeWidget_New	Allocates memory for and initializes a new widget of this type. The application is responsible for the management of this memory until the widget is added to a widget tree.
	laCircularGaugeWidget_SetCenterAngle	Sets the center angle of the gauge.
	laCircularGaugeWidget_SetCenterCircleRadius	Sets the center radius of the center circle
	laCircularGaugeWidget_SetCenterCircleThickness	Sets the thickness of the center circle
	laCircularGaugeWidget_SetCenterCircleVisible	Sets the center circle visible/invisible
	laCircularGaugeWidget_SetEndValue	Sets the end value of the gauge
	laCircularGaugeWidget_SetHandRadius	Sets the radius/length of the hand
	laCircularGaugeWidget_SetHandVisible	Sets the hand visible/invisible
	laCircularGaugeWidget_SetRadius	Sets the radius of a gauge widget
	laCircularGaugeWidget_SetStartAngle	Sets the start angle of the gauge.
	laCircularGaugeWidget_SetStartValue	Sets the start value of the gauge
	laCircularGaugeWidget_SetStringTable	Sets the string table to be used for the tick labels
	laCircularGaugeWidget_SetTickLabelsVisible	Sets the tick labels visible/invisible
	laCircularGaugeWidget_SetTickLength	Sets the length of the ticks
	laCircularGaugeWidget_SetTicksLabelsStringID	Sets the ID of the string character superset to be used for the tick labels
	laCircularGaugeWidget_SetTicksVisible	Sets the increments/distance between ticks
	laCircularGaugeWidget_SetTickValue	Sets the increments/distance between ticks
	laCircularGaugeWidget_SetValue	Sets the value of the gauge hand
	laCircularGaugeWidget_SetValueChangedEventCallback	Sets the function to be called back when the gauge value changes.

Macros

	Name	Description
	LIBARIA_WIDGET_CIRCULAR_GAUGE_H	This is macro LIBARIA_WIDGET_CIRCULAR_GAUGE_H.

Structures

	Name	Description
	laCircularGaugeArc_t	Internal structure for the arcs in the circular gauge widget
	laCircularGaugeLabel_t	Label object for the circular gauge
	laCircularGaugeTick_t	Tick object for the circular gauge
	laCircularGaugeWidget_t	Implementation of a circular gauge widget.
	laCircularGaugeArc	Internal structure for the arcs in the circular gauge widget
	laCircularGaugeLabel	Label object for the circular gauge
	laCircularGaugeTick	Tick object for the circular gauge
	laCircularGaugeWidget	Implementation of a circular gauge widget.

Types

	Name	Description
	laCircularGaugeWidget_ValueChangedEvent	Value changed event function callback type

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

MPLAB® Harmony Graphics Suite

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support