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

Microchip Technology Inc.

File Name

libaria_widget_button.h

Description

Module for Microchip Graphics Library - Aria User Interface Library

Enumerations
 
Name 
Description 
 
Controls the button pressed state 
 
Controls the button pressed state 
Functions
 
Name 
Description 
 
Gets the horizontal alignment setting for a button 
 
Gets the distance between the icon and the text 
 
Gets the position of the button icon 
 
Gets the pressed state of a button 
 
Gets the callback associated with the button pressed event 
 
Gets the pressed image asset pointer for a button 
 
Gets the offset of the button internals when pressed 
 
Gets the callback for the button released event 
 
Gets the currently used released icon 
 
Gets the text for a button. If the button's string has local data then a duplicate of the string will be allocated. The caller is responsible for managing the memory for the duplicated string. If the button string is a string table reference then only the reference ID is copied. 
 
Returns the line spacing in pixels for the button text. If < 0, the ascent value of the string's font is used. 
 
Gets the value of this button's toggle flag 
 
Gets the vertical alignment setting for a button 
 
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. 
 
Sets the horizontal alignment value for a button 
 
Sets the distance between the icon and text 
 
Sets the position of the button icon 
 
Sets the pressed state for a button. 
 
Sets the pressed event callback for the button 
 
Sets the image to be used as a pressed icon 
 
Sets the offset of the button internals when pressed 
 
Sets the callback for the button released event 
 
Sets the image to be used as the released icon 
 
Sets the text for a button. If the input string has local data then the data will be copied into the button's local string, causing a memory allocation. If the input string is a string table reference then only the reference will be copied. The input string can be safely modified and the button string will not be affected. 
 
Sets the line space in pixels of the text in the button widget. A value < 0 sets the spacing to the ascent value of the string's font. 
 
Enables the toggle mode for a button. When pressed, toggle buttons will stay down until pressed again. 
 
Sets the vertical alignment for a button 
Structures
 
Name 
Description 
 
Implementation of a button widget. A button is an interactive element that simulates a typical button with a pressed an released state. 
Types
 
Name 
Description 
 
Button pressed event function callback type 
 
Button released event function callback type 
MPLAB® Harmony Graphics Suite