mirror of
https://github.com/lvgl/lvgl.git
synced 2024-11-24 02:03:53 +08:00
130 lines
3.2 KiB
C
130 lines
3.2 KiB
C
/**
|
|
* @file lv_line.h
|
|
*
|
|
*/
|
|
|
|
#ifndef LV_LINE_H
|
|
#define LV_LINE_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*********************
|
|
* INCLUDES
|
|
*********************/
|
|
#include "../../lv_conf.h"
|
|
#if USE_LV_LINE != 0
|
|
|
|
#include "../lv_core/lv_obj.h"
|
|
|
|
/*********************
|
|
* DEFINES
|
|
*********************/
|
|
|
|
/**********************
|
|
* TYPEDEFS
|
|
**********************/
|
|
|
|
/*Data of line*/
|
|
typedef struct
|
|
{
|
|
/*Inherited from 'base_obj' so no inherited ext.*/ /*Ext. of ancestor*/
|
|
const lv_point_t * point_array; /*Pointer to an array with the points of the line*/
|
|
uint16_t point_num; /*Number of points in 'point_array' */
|
|
uint8_t auto_size :1; /*1: set obj. width to x max and obj. height to y max */
|
|
uint8_t y_inv :1; /*1: y == 0 will be on the bottom*/
|
|
}lv_line_ext_t;
|
|
|
|
/**********************
|
|
* GLOBAL PROTOTYPES
|
|
**********************/
|
|
|
|
|
|
/**
|
|
* Create a line objects
|
|
* @param par pointer to an object, it will be the parent of the new line
|
|
* @return pointer to the created line
|
|
*/
|
|
lv_obj_t * lv_line_create(lv_obj_t * par, lv_obj_t * copy);
|
|
|
|
/*=====================
|
|
* Setter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Set an array of points. The line object will connect these points.
|
|
* @param line pointer to a line object
|
|
* @param point_a an array of points. Only the address is saved,
|
|
* so the array can NOT be a local variable which will be destroyed
|
|
* @param point_num number of points in 'point_a'
|
|
*/
|
|
void lv_line_set_points(lv_obj_t * line, const lv_point_t * point_a, uint16_t point_num);
|
|
|
|
/**
|
|
* Enable (or disable) the auto-size option. The size of the object will fit to its points.
|
|
* (set width to x max and height to y max)
|
|
* @param line pointer to a line object
|
|
* @param autosize_en true: auto size is enabled, false: auto size is disabled
|
|
*/
|
|
void lv_line_set_auto_size(lv_obj_t * line, bool autosize_en);
|
|
|
|
/**
|
|
* Enable (or disable) the y coordinate inversion.
|
|
* If enabled then y will be subtracted from the height of the object,
|
|
* therefore the y=0 coordinate will be on the bottom.
|
|
* @param line pointer to a line object
|
|
* @param yinv_en true: enable the y inversion, false:disable the y inversion
|
|
*/
|
|
void lv_line_set_y_invert(lv_obj_t * line, bool yinv_en);
|
|
|
|
/**
|
|
* Set the style of a line
|
|
* @param line pointer to a line object
|
|
* @param style pointer to a style
|
|
*/
|
|
static inline void lv_line_set_style(lv_obj_t *line, lv_style_t *style)
|
|
{
|
|
lv_obj_set_style(line, style);
|
|
}
|
|
|
|
/*=====================
|
|
* Getter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Get the auto size attribute
|
|
* @param line pointer to a line object
|
|
* @return true: auto size is enabled, false: disabled
|
|
*/
|
|
bool lv_line_get_auto_size(lv_obj_t * line);
|
|
|
|
/**
|
|
* Get the y inversion attribute
|
|
* @param line pointer to a line object
|
|
* @return true: y inversion is enabled, false: disabled
|
|
*/
|
|
bool lv_line_get_y_inv(lv_obj_t * line);
|
|
|
|
/**
|
|
* Get the style of an line object
|
|
* @param line pointer to an line object
|
|
* @return pointer to the line's style
|
|
*/
|
|
static inline lv_style_t* lv_line_get_style(lv_obj_t *line)
|
|
{
|
|
return lv_obj_get_style(line);
|
|
}
|
|
|
|
/**********************
|
|
* MACROS
|
|
**********************/
|
|
|
|
#endif /*USE_LV_LINE*/
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /*LV_LINE_H*/
|