403 lines
13 KiB
C
403 lines
13 KiB
C
|
/*
|
||
|
|
* Copyright (c) 2019 CTCaer
|
||
|
|
*
|
||
|
|
* This program is free software; you can redistribute it and/or modify it
|
||
|
|
* under the terms and conditions of the GNU General Public License,
|
||
|
|
* version 2, as published by the Free Software Foundation.
|
||
|
|
*
|
||
|
|
* This program is distributed in the hope it will be useful, but WITHOUT
|
||
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||
|
|
* more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU General Public License
|
||
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @file lv_page.h
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef LV_PAGE_H
|
||
|
|
#define LV_PAGE_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_PAGE != 0
|
||
|
|
|
||
|
|
/*Testing of dependencies*/
|
||
|
|
#if USE_LV_CONT == 0
|
||
|
|
#error "lv_page: lv_cont is required. Enable it in lv_conf.h (USE_LV_CONT 1) "
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#include "lv_cont.h"
|
||
|
|
#include "../lv_core/lv_indev.h"
|
||
|
|
|
||
|
|
/*********************
|
||
|
|
* DEFINES
|
||
|
|
*********************/
|
||
|
|
|
||
|
|
/**********************
|
||
|
|
* TYPEDEFS
|
||
|
|
**********************/
|
||
|
|
|
||
|
|
/*Scrollbar modes: shows when should the scrollbars be visible*/
|
||
|
|
enum
|
||
|
|
{
|
||
|
|
LV_SB_MODE_OFF = 0x0, /*Never show scrollbars*/
|
||
|
|
LV_SB_MODE_ON = 0x1, /*Always show scrollbars*/
|
||
|
|
LV_SB_MODE_DRAG = 0x2, /*Show scrollbars when page is being dragged*/
|
||
|
|
LV_SB_MODE_AUTO = 0x3, /*Show scrollbars when the scrollable container is large enough to be scrolled*/
|
||
|
|
LV_SB_MODE_HIDE = 0x4, /*Hide the scroll bar temporally*/
|
||
|
|
LV_SB_MODE_UNHIDE = 0x5, /*Unhide the previously hidden scrollbar. Recover it's type too*/
|
||
|
|
};
|
||
|
|
typedef uint8_t lv_sb_mode_t;
|
||
|
|
|
||
|
|
/*Data of page*/
|
||
|
|
typedef struct
|
||
|
|
{
|
||
|
|
lv_cont_ext_t bg; /*Ext. of ancestor*/
|
||
|
|
/*New data for this type */
|
||
|
|
lv_obj_t * scrl; /*The scrollable object on the background*/
|
||
|
|
lv_style_t *bgo; /*The scrollable object on the background*/
|
||
|
|
lv_style_t *pr; /*The scrollable object on the background*/
|
||
|
|
lv_action_t rel_action; /*Function to call when the page is released*/
|
||
|
|
lv_action_t pr_action; /*Function to call when the page is pressed*/
|
||
|
|
struct {
|
||
|
|
lv_style_t *style; /*Style of scrollbars*/
|
||
|
|
lv_area_t hor_area; /*Horizontal scrollbar area relative to the page. (Handled by the library) */
|
||
|
|
lv_area_t ver_area; /*Vertical scrollbar area relative to the page (Handled by the library)*/
|
||
|
|
uint8_t hor_draw :1; /*1: horizontal scrollbar is visible now (Handled by the library)*/
|
||
|
|
uint8_t ver_draw :1; /*1: vertical scrollbar is visible now (Handled by the library)*/
|
||
|
|
lv_sb_mode_t mode:3; /*Scrollbar visibility from 'lv_page_sb_mode_t'*/
|
||
|
|
} sb;
|
||
|
|
struct {
|
||
|
|
uint16_t state; /*Store the current size of the edge flash effect*/
|
||
|
|
lv_style_t *style; /*Style of edge flash effect (usually homogeneous circle)*/
|
||
|
|
uint8_t enabled :1; /*1: Show a flash animation on the edge*/
|
||
|
|
uint8_t top_ip :1; /*Used internally to show that top most position is reached (flash is In Progress)*/
|
||
|
|
uint8_t bottom_ip :1; /*Used internally to show that bottom most position is reached (flash is In Progress)*/
|
||
|
|
uint8_t right_ip :1; /*Used internally to show that right most position is reached (flash is In Progress)*/
|
||
|
|
uint8_t left_ip :1; /*Used internally to show that left most position is reached (flash is In Progress)*/
|
||
|
|
}edge_flash;
|
||
|
|
|
||
|
|
uint8_t arrow_scroll :1; /*1: Enable scrolling with LV_GROUP_KEY_LEFT/RIGHT/UP/DOWN*/
|
||
|
|
uint8_t scroll_prop :1; /*1: Propagate the scrolling the the parent if the edge is reached*/
|
||
|
|
uint8_t scroll_prop_ip :1; /*1: Scroll propagation is in progress (used by the library)*/
|
||
|
|
} lv_page_ext_t;
|
||
|
|
|
||
|
|
enum {
|
||
|
|
LV_PAGE_STYLE_BG,
|
||
|
|
LV_PAGE_STYLE_BGO,
|
||
|
|
LV_PAGE_STYLE_PR,
|
||
|
|
LV_PAGE_STYLE_SCRL,
|
||
|
|
LV_PAGE_STYLE_SB,
|
||
|
|
LV_PAGE_STYLE_EDGE_FLASH,
|
||
|
|
};
|
||
|
|
typedef uint8_t lv_page_style_t;
|
||
|
|
|
||
|
|
/**********************
|
||
|
|
* GLOBAL PROTOTYPES
|
||
|
|
**********************/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a page objects
|
||
|
|
* @param par pointer to an object, it will be the parent of the new page
|
||
|
|
* @param copy pointer to a page object, if not NULL then the new object will be copied from it
|
||
|
|
* @return pointer to the created page
|
||
|
|
*/
|
||
|
|
lv_obj_t * lv_page_create(lv_obj_t * par, const lv_obj_t * copy);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete all children of the scrl object, without deleting scrl child.
|
||
|
|
* @param obj pointer to an object
|
||
|
|
*/
|
||
|
|
void lv_page_clean(lv_obj_t *obj);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the press action of the page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return a function to call when the page is pressed
|
||
|
|
*/
|
||
|
|
lv_action_t lv_page_get_pr_action(lv_obj_t * page);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the release action of the page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return a function to call when the page is released
|
||
|
|
*/
|
||
|
|
lv_action_t lv_page_get_rel_action(lv_obj_t * page);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the scrollable object of a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return pointer to a container which is the scrollable part of the page
|
||
|
|
*/
|
||
|
|
lv_obj_t * lv_page_get_scrl(const lv_obj_t * page);
|
||
|
|
|
||
|
|
/*=====================
|
||
|
|
* Setter functions
|
||
|
|
*====================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set a release action for the page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param rel_action a function to call when the page is released
|
||
|
|
*/
|
||
|
|
void lv_page_set_rel_action(lv_obj_t * page, lv_action_t rel_action);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set a press action for the page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param pr_action a function to call when the page is pressed
|
||
|
|
*/
|
||
|
|
void lv_page_set_pr_action(lv_obj_t * page, lv_action_t pr_action);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the scroll bar mode on a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param sb_mode the new mode from 'lv_page_sb.mode_t' enum
|
||
|
|
*/
|
||
|
|
void lv_page_set_sb_mode(lv_obj_t * page, lv_sb_mode_t sb_mode);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enable/Disable scrolling with arrows if the page is in group (arrows: LV_GROUP_KEY_LEFT/RIGHT/UP/DOWN)
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param en true: enable scrolling with arrows
|
||
|
|
*/
|
||
|
|
void lv_page_set_arrow_scroll(lv_obj_t * page, bool en);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enable the scroll propagation feature. If enabled then the page will move its parent if there is no more space to scroll.
|
||
|
|
* @param page pointer to a Page
|
||
|
|
* @param en true or false to enable/disable scroll propagation
|
||
|
|
*/
|
||
|
|
void lv_page_set_scroll_propagation(lv_obj_t * page, bool en);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enable the edge flash effect. (Show an arc when the an edge is reached)
|
||
|
|
* @param page pointer to a Page
|
||
|
|
* @param en true or false to enable/disable end flash
|
||
|
|
*/
|
||
|
|
void lv_page_set_edge_flash(lv_obj_t * page, bool en);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the fit attribute of the scrollable part of a page.
|
||
|
|
* It means it can set its size automatically to involve all children.
|
||
|
|
* (Can be set separately horizontally and vertically)
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param hor_en true: enable horizontal fit
|
||
|
|
* @param ver_en true: enable vertical fit
|
||
|
|
*/
|
||
|
|
static inline void lv_page_set_scrl_fit(lv_obj_t *page, bool hor_en, bool ver_en)
|
||
|
|
{
|
||
|
|
lv_cont_set_fit(lv_page_get_scrl(page), hor_en, ver_en);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set width of the scrollable part of a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param w the new width of the scrollable (it ha no effect is horizontal fit is enabled)
|
||
|
|
*/
|
||
|
|
static inline void lv_page_set_scrl_width(lv_obj_t *page, lv_coord_t w)
|
||
|
|
{
|
||
|
|
lv_obj_set_width(lv_page_get_scrl(page), w);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set height of the scrollable part of a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param h the new height of the scrollable (it ha no effect is vertical fit is enabled)
|
||
|
|
*/
|
||
|
|
static inline void lv_page_set_scrl_height(lv_obj_t *page, lv_coord_t h)
|
||
|
|
{
|
||
|
|
lv_obj_set_height(lv_page_get_scrl(page), h);
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the layout of the scrollable part of the page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param layout a layout from 'lv_cont_layout_t'
|
||
|
|
*/
|
||
|
|
static inline void lv_page_set_scrl_layout(lv_obj_t * page, lv_layout_t layout)
|
||
|
|
{
|
||
|
|
lv_cont_set_layout(lv_page_get_scrl(page), layout);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set a style of a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param type which style should be set
|
||
|
|
* @param style pointer to a style
|
||
|
|
*/
|
||
|
|
void lv_page_set_style(lv_obj_t *page, lv_page_style_t type, lv_style_t *style);
|
||
|
|
|
||
|
|
/*=====================
|
||
|
|
* Getter functions
|
||
|
|
*====================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the scroll bar mode on a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return the mode from 'lv_page_sb.mode_t' enum
|
||
|
|
*/
|
||
|
|
lv_sb_mode_t lv_page_get_sb_mode(const lv_obj_t * page);
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the the scrolling with arrows (LV_GROUP_KEY_LEFT/RIGHT/UP/DOWN) is enabled or not
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return true: scrolling with arrows is enabled
|
||
|
|
*/
|
||
|
|
bool lv_page_get_arrow_scroll(const lv_obj_t * page);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the scroll propagation property
|
||
|
|
* @param page pointer to a Page
|
||
|
|
* @return true or false
|
||
|
|
*/
|
||
|
|
bool lv_page_get_scroll_propagation(lv_obj_t * page);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the edge flash effect property.
|
||
|
|
* @param page pointer to a Page
|
||
|
|
* return true or false
|
||
|
|
*/
|
||
|
|
bool lv_page_get_edge_flash(lv_obj_t * page);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get that width which can be set to the children to still not cause overflow (show scrollbars)
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return the width which still fits into the page
|
||
|
|
*/
|
||
|
|
lv_coord_t lv_page_get_fit_width(lv_obj_t * page);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get that height which can be set to the children to still not cause overflow (show scrollbars)
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return the height which still fits into the page
|
||
|
|
*/
|
||
|
|
lv_coord_t lv_page_get_fit_height(lv_obj_t * page);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get width of the scrollable part of a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return the width of the scrollable
|
||
|
|
*/
|
||
|
|
static inline lv_coord_t lv_page_get_scrl_width(const lv_obj_t *page)
|
||
|
|
{
|
||
|
|
return lv_obj_get_width(lv_page_get_scrl(page));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get height of the scrollable part of a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return the height of the scrollable
|
||
|
|
*/
|
||
|
|
static inline lv_coord_t lv_page_get_scrl_height(const lv_obj_t *page)
|
||
|
|
{
|
||
|
|
return lv_obj_get_height(lv_page_get_scrl(page));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the layout of the scrollable part of a page
|
||
|
|
* @param page pointer to page object
|
||
|
|
* @return the layout from 'lv_cont_layout_t'
|
||
|
|
*/
|
||
|
|
static inline lv_layout_t lv_page_get_scrl_layout(const lv_obj_t * page)
|
||
|
|
{
|
||
|
|
return lv_cont_get_layout(lv_page_get_scrl(page));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get horizontal fit attribute of the scrollable part of a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return true: horizontal fit is enabled; false: disabled
|
||
|
|
*/
|
||
|
|
static inline bool lv_page_get_scrl_hor_fit(const lv_obj_t * page)
|
||
|
|
{
|
||
|
|
return lv_cont_get_hor_fit(lv_page_get_scrl(page));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get vertical fit attribute of the scrollable part of a page
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @return true: vertical fit is enabled; false: disabled
|
||
|
|
*/
|
||
|
|
static inline bool lv_page_get_scrl_fit_ver(const lv_obj_t * page)
|
||
|
|
{
|
||
|
|
return lv_cont_get_ver_fit(lv_page_get_scrl(page));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get a style of a page
|
||
|
|
* @param page pointer to page object
|
||
|
|
* @param type which style should be get
|
||
|
|
* @return style pointer to a style
|
||
|
|
*/
|
||
|
|
lv_style_t * lv_page_get_style(const lv_obj_t *page, lv_page_style_t type);
|
||
|
|
|
||
|
|
/*=====================
|
||
|
|
* Other functions
|
||
|
|
*====================*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Glue the object to the page. After it the page can be moved (dragged) with this object too.
|
||
|
|
* @param obj pointer to an object on a page
|
||
|
|
* @param glue true: enable glue, false: disable glue
|
||
|
|
*/
|
||
|
|
void lv_page_glue_obj(lv_obj_t * obj, bool glue);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Focus on an object. It ensures that the object will be visible on the page.
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param obj pointer to an object to focus (must be on the page)
|
||
|
|
* @param anim_time scroll animation time in milliseconds (0: no animation)
|
||
|
|
*/
|
||
|
|
void lv_page_focus(lv_obj_t * page, const lv_obj_t * obj, uint16_t anim_time);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Scroll the page horizontally
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param dist the distance to scroll (< 0: scroll left; > 0 scroll right)
|
||
|
|
*/
|
||
|
|
void lv_page_scroll_hor(lv_obj_t * page, lv_coord_t dist);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Scroll the page vertically
|
||
|
|
* @param page pointer to a page object
|
||
|
|
* @param dist the distance to scroll (< 0: scroll down; > 0 scroll up)
|
||
|
|
*/
|
||
|
|
void lv_page_scroll_ver(lv_obj_t * page, lv_coord_t dist);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Not intended to use directly by the user but by other object types internally.
|
||
|
|
* Start an edge flash animation. Exactly one `ext->edge_flash.xxx_ip` should be set
|
||
|
|
* @param page
|
||
|
|
*/
|
||
|
|
void lv_page_start_edge_flash(lv_obj_t * page);
|
||
|
|
/**********************
|
||
|
|
* MACROS
|
||
|
|
**********************/
|
||
|
|
|
||
|
|
#endif /*USE_LV_PAGE*/
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
} /* extern "C" */
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /*LV_PAGE_H*/
|