mirror of
https://github.com/CTCaer/hekate
synced 2024-12-22 19:31:12 +00:00
185526d134
BDK will allow developers to use the full collection of drivers, with limited editing, if any, for making payloads for Nintendo Switch. Using a single source for everything will also help decoupling Switch specific code and easily port it to other Tegra X1/X1+ platforms. And maybe even to lower targets. Everything is now centrilized into bdk folder. Every module or project can utilize it by simply including it. This is just the start and it will continue to improve.
390 lines
10 KiB
C
390 lines
10 KiB
C
/**
|
|
* @file lv_ta.h
|
|
*
|
|
*/
|
|
|
|
#ifndef LV_TA_H
|
|
#define LV_TA_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*********************
|
|
* INCLUDES
|
|
*********************/
|
|
#ifdef LV_CONF_INCLUDE_SIMPLE
|
|
#include "lv_conf.h"
|
|
#else
|
|
#include "../../lv_conf.h"
|
|
#endif
|
|
|
|
#if USE_LV_TA != 0
|
|
|
|
/*Testing of dependencies*/
|
|
#if USE_LV_PAGE == 0
|
|
#error "lv_ta: lv_page is required. Enable it in lv_conf.h (USE_LV_PAGE 1) "
|
|
#endif
|
|
|
|
#if USE_LV_LABEL == 0
|
|
#error "lv_ta: lv_label is required. Enable it in lv_conf.h (USE_LV_LABEL 1) "
|
|
#endif
|
|
|
|
#include "../lv_core/lv_obj.h"
|
|
#include "lv_page.h"
|
|
#include "lv_label.h"
|
|
|
|
/*********************
|
|
* DEFINES
|
|
*********************/
|
|
#define LV_TA_CURSOR_LAST (0x7FFF) /*Put the cursor after the last character*/
|
|
|
|
/**********************
|
|
* TYPEDEFS
|
|
**********************/
|
|
|
|
enum {
|
|
LV_CURSOR_NONE,
|
|
LV_CURSOR_LINE,
|
|
LV_CURSOR_BLOCK,
|
|
LV_CURSOR_OUTLINE,
|
|
LV_CURSOR_UNDERLINE,
|
|
LV_CURSOR_HIDDEN = 0x08, /*Or it to any value to hide the cursor temporally*/
|
|
};
|
|
typedef uint8_t lv_cursor_type_t;
|
|
|
|
/*Data of text area*/
|
|
typedef struct
|
|
{
|
|
lv_page_ext_t page; /*Ext. of ancestor*/
|
|
/*New data for this type */
|
|
lv_obj_t * label; /*Label of the text area*/
|
|
char * pwd_tmp; /*Used to store the original text in password mode*/
|
|
const char * accapted_chars;/*Only these characters will be accepted. NULL: accept all*/
|
|
uint16_t max_length; /*The max. number of characters. 0: no limit*/
|
|
uint8_t pwd_mode :1; /*Replace characters with '*' */
|
|
uint8_t one_line :1; /*One line mode (ignore line breaks)*/
|
|
struct {
|
|
lv_style_t *style; /*Style of the cursor (NULL to use label's style)*/
|
|
lv_coord_t valid_x; /*Used when stepping up/down in text area when stepping to a shorter line. (Handled by the library)*/
|
|
uint16_t pos; /*The current cursor position (0: before 1. letter; 1: before 2. letter etc.)*/
|
|
lv_area_t area; /*Cursor area relative to the Text Area*/
|
|
uint16_t txt_byte_pos; /*Byte index of the letter after (on) the cursor*/
|
|
lv_cursor_type_t type:4; /*Shape of the cursor*/
|
|
uint8_t state :1; /*Indicates that the cursor is visible now or not (Handled by the library)*/
|
|
} cursor;
|
|
} lv_ta_ext_t;
|
|
|
|
enum {
|
|
LV_TA_STYLE_BG,
|
|
LV_TA_STYLE_SB,
|
|
LV_TA_STYLE_EDGE_FLASH,
|
|
LV_TA_STYLE_CURSOR,
|
|
};
|
|
typedef uint8_t lv_ta_style_t;
|
|
|
|
/**********************
|
|
* GLOBAL PROTOTYPES
|
|
**********************/
|
|
|
|
|
|
/**
|
|
* Create a text area objects
|
|
* @param par pointer to an object, it will be the parent of the new text area
|
|
* @param copy pointer to a text area object, if not NULL then the new object will be copied from it
|
|
* @return pointer to the created text area
|
|
*/
|
|
lv_obj_t * lv_ta_create(lv_obj_t * par, const lv_obj_t * copy);
|
|
|
|
|
|
/*======================
|
|
* Add/remove functions
|
|
*=====================*/
|
|
|
|
/**
|
|
* Insert a character to the current cursor position.
|
|
* To add a wide char, e.g. 'Á' use `lv_txt_encoded_conv_wc('Á')`
|
|
* @param ta pointer to a text area object
|
|
* @param c a character (e.g. 'a')
|
|
*/
|
|
void lv_ta_add_char(lv_obj_t * ta, uint32_t c);
|
|
|
|
/**
|
|
* Insert a text to the current cursor position
|
|
* @param ta pointer to a text area object
|
|
* @param txt a '\0' terminated string to insert
|
|
*/
|
|
void lv_ta_add_text(lv_obj_t * ta, const char * txt);
|
|
|
|
/**
|
|
* Delete a the left character from the current cursor position
|
|
* @param ta pointer to a text area object
|
|
*/
|
|
void lv_ta_del_char(lv_obj_t * ta);
|
|
|
|
/*=====================
|
|
* Setter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Set the text of a text area
|
|
* @param ta pointer to a text area
|
|
* @param txt pointer to the text
|
|
*/
|
|
void lv_ta_set_text(lv_obj_t * ta, const char * txt);
|
|
|
|
/**
|
|
* Set the cursor position
|
|
* @param obj pointer to a text area object
|
|
* @param pos the new cursor position in character index
|
|
* < 0 : index from the end of the text
|
|
* LV_TA_CURSOR_LAST: go after the last character
|
|
*/
|
|
void lv_ta_set_cursor_pos(lv_obj_t * ta, int16_t pos);
|
|
|
|
/**
|
|
* Set the cursor type.
|
|
* @param ta pointer to a text area object
|
|
* @param cur_type: element of 'lv_cursor_type_t'
|
|
*/
|
|
void lv_ta_set_cursor_type(lv_obj_t * ta, lv_cursor_type_t cur_type);
|
|
|
|
/**
|
|
* Enable/Disable password mode
|
|
* @param ta pointer to a text area object
|
|
* @param en true: enable, false: disable
|
|
*/
|
|
void lv_ta_set_pwd_mode(lv_obj_t * ta, bool en);
|
|
|
|
/**
|
|
* Configure the text area to one line or back to normal
|
|
* @param ta pointer to a Text area object
|
|
* @param en true: one line, false: normal
|
|
*/
|
|
void lv_ta_set_one_line(lv_obj_t * ta, bool en);
|
|
|
|
/**
|
|
* Set the alignment of the text area.
|
|
* In one line mode the text can be scrolled only with `LV_LABEL_ALIGN_LEFT`.
|
|
* This function should be called if the size of text area changes.
|
|
* @param ta pointer to a text are object
|
|
* @param align the desired alignment from `lv_label_align_t`. (LV_LABEL_ALIGN_LEFT/CENTER/RIGHT)
|
|
*/
|
|
void lv_ta_set_text_align(lv_obj_t * ta, lv_label_align_t align);
|
|
|
|
/**
|
|
* Set a list of characters. Only these characters will be accepted by the text area
|
|
* @param ta pointer to Text Area
|
|
* @param list list of characters. Only the pointer is saved. E.g. "+-.,0123456789"
|
|
*/
|
|
void lv_ta_set_accepted_chars(lv_obj_t * ta, const char * list);
|
|
|
|
/**
|
|
* Set max length of a Text Area.
|
|
* @param ta pointer to Text Area
|
|
* @param num the maximal number of characters can be added (`lv_ta_set_text` ignores it)
|
|
*/
|
|
void lv_ta_set_max_length(lv_obj_t * ta, uint16_t num);
|
|
|
|
/**
|
|
* Set an action to call when the Text area is clicked
|
|
* @param ta pointer to a Text area
|
|
* @param action a function pointer
|
|
*/
|
|
static inline void lv_ta_set_action(lv_obj_t * ta, lv_action_t action)
|
|
{
|
|
lv_page_set_rel_action(ta, action);
|
|
}
|
|
|
|
/**
|
|
* Set the scroll bar mode of a text area
|
|
* @param ta pointer to a text area object
|
|
* @param sb_mode the new mode from 'lv_page_sb_mode_t' enum
|
|
*/
|
|
static inline void lv_ta_set_sb_mode(lv_obj_t * ta, lv_sb_mode_t mode)
|
|
{
|
|
lv_page_set_sb_mode(ta, mode);
|
|
}
|
|
|
|
/**
|
|
* Enable the scroll propagation feature. If enabled then the Text area will move its parent if there is no more space to scroll.
|
|
* @param ta pointer to a Text area
|
|
* @param en true or false to enable/disable scroll propagation
|
|
*/
|
|
static inline void lv_ta_set_scroll_propagation(lv_obj_t * ta, bool en)
|
|
{
|
|
lv_page_set_scroll_propagation(ta, en);
|
|
}
|
|
|
|
/**
|
|
* Enable the edge flash effect. (Show an arc when the an edge is reached)
|
|
* @param page pointer to a Text Area
|
|
* @param en true or false to enable/disable end flash
|
|
*/
|
|
static inline void lv_ta_set_edge_flash(lv_obj_t * ta, bool en)
|
|
{
|
|
lv_page_set_edge_flash(ta, en);
|
|
}
|
|
|
|
/**
|
|
* Set a style of a text area
|
|
* @param ta pointer to a text area object
|
|
* @param type which style should be set
|
|
* @param style pointer to a style
|
|
*/
|
|
void lv_ta_set_style(lv_obj_t *ta, lv_ta_style_t type, lv_style_t *style);
|
|
|
|
/*=====================
|
|
* Getter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Get the text of a text area. In password mode it gives the real text (not '*'s).
|
|
* @param ta pointer to a text area object
|
|
* @return pointer to the text
|
|
*/
|
|
const char * lv_ta_get_text(const lv_obj_t * ta);
|
|
|
|
/**
|
|
* Get the label of a text area
|
|
* @param ta pointer to a text area object
|
|
* @return pointer to the label object
|
|
*/
|
|
lv_obj_t * lv_ta_get_label(const lv_obj_t * ta);
|
|
|
|
/**
|
|
* Get the current cursor position in character index
|
|
* @param ta pointer to a text area object
|
|
* @return the cursor position
|
|
*/
|
|
uint16_t lv_ta_get_cursor_pos(const lv_obj_t * ta);
|
|
|
|
/**
|
|
* Get the current cursor visibility.
|
|
* @param ta pointer to a text area object
|
|
* @return true: the cursor is drawn, false: the cursor is hidden
|
|
*/
|
|
//bool lv_ta_get_cursor_show(const lv_obj_t * ta);
|
|
|
|
/**
|
|
* Get the current cursor type.
|
|
* @param ta pointer to a text area object
|
|
* @return element of 'lv_cursor_type_t'
|
|
*/
|
|
lv_cursor_type_t lv_ta_get_cursor_type(const lv_obj_t * ta);
|
|
|
|
/**
|
|
* Get the password mode attribute
|
|
* @param ta pointer to a text area object
|
|
* @return true: password mode is enabled, false: disabled
|
|
*/
|
|
bool lv_ta_get_pwd_mode(const lv_obj_t * ta);
|
|
|
|
/**
|
|
* Get the one line configuration attribute
|
|
* @param ta pointer to a text area object
|
|
* @return true: one line configuration is enabled, false: disabled
|
|
*/
|
|
bool lv_ta_get_one_line(const lv_obj_t * ta);
|
|
|
|
/**
|
|
* Get a list of accepted characters.
|
|
* @param ta pointer to Text Area
|
|
* @return list of accented characters.
|
|
*/
|
|
const char * lv_ta_get_accepted_chars(lv_obj_t * ta);
|
|
|
|
/**
|
|
* Set max length of a Text Area.
|
|
* @param ta pointer to Text Area
|
|
* @return the maximal number of characters to be add
|
|
*/
|
|
uint16_t lv_ta_get_max_length(lv_obj_t * ta);
|
|
|
|
/**
|
|
* Set an action to call when the Text area is clicked
|
|
* @param ta pointer to a Text area
|
|
* @param action a function pointer
|
|
*/
|
|
static inline lv_action_t lv_ta_get_action(lv_obj_t * ta)
|
|
{
|
|
return lv_page_get_rel_action(ta);
|
|
}
|
|
|
|
/**
|
|
* Get the scroll bar mode of a text area
|
|
* @param ta pointer to a text area object
|
|
* @return scrollbar mode from 'lv_page_sb_mode_t' enum
|
|
*/
|
|
static inline lv_sb_mode_t lv_ta_get_sb_mode(const lv_obj_t * ta)
|
|
{
|
|
return lv_page_get_sb_mode(ta);
|
|
}
|
|
|
|
/**
|
|
* Get the scroll propagation property
|
|
* @param ta pointer to a Text area
|
|
* @return true or false
|
|
*/
|
|
static inline bool lv_ta_get_scroll_propagation(lv_obj_t * ta)
|
|
{
|
|
return lv_page_get_scroll_propagation(ta);
|
|
}
|
|
|
|
/**
|
|
* Get the scroll propagation property
|
|
* @param ta pointer to a Text area
|
|
* @return true or false
|
|
*/
|
|
static inline bool lv_ta_get_edge_flash(lv_obj_t * ta)
|
|
{
|
|
return lv_page_get_edge_flash(ta);
|
|
}
|
|
|
|
/**
|
|
* Get a style of a text area
|
|
* @param ta pointer to a text area object
|
|
* @param type which style should be get
|
|
* @return style pointer to a style
|
|
*/
|
|
lv_style_t * lv_ta_get_style(const lv_obj_t *ta, lv_ta_style_t type);
|
|
|
|
/*=====================
|
|
* Other functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Move the cursor one character right
|
|
* @param ta pointer to a text area object
|
|
*/
|
|
void lv_ta_cursor_right(lv_obj_t * ta);
|
|
|
|
/**
|
|
* Move the cursor one character left
|
|
* @param ta pointer to a text area object
|
|
*/
|
|
void lv_ta_cursor_left(lv_obj_t * ta);
|
|
|
|
/**
|
|
* Move the cursor one line down
|
|
* @param ta pointer to a text area object
|
|
*/
|
|
void lv_ta_cursor_down(lv_obj_t * ta);
|
|
|
|
/**
|
|
* Move the cursor one line up
|
|
* @param ta pointer to a text area object
|
|
*/
|
|
void lv_ta_cursor_up(lv_obj_t * ta);
|
|
|
|
/**********************
|
|
* MACROS
|
|
**********************/
|
|
|
|
#endif /*USE_LV_TA_H*/
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /*LV_TA_H*/
|