315 lines
8.7 KiB
C
315 lines
8.7 KiB
C
/**
|
|
* @file lv_win.h
|
|
*
|
|
*/
|
|
|
|
#ifndef LV_WIN_H
|
|
#define LV_WIN_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*********************
|
|
* INCLUDES
|
|
*********************/
|
|
#include "../lv_conf_internal.h"
|
|
|
|
#if LV_USE_WIN != 0
|
|
|
|
/*Testing of dependencies*/
|
|
#if LV_USE_BTN == 0
|
|
#error "lv_win: lv_btn is required. Enable it in lv_conf.h (LV_USE_BTN 1)"
|
|
#endif
|
|
|
|
#if LV_USE_LABEL == 0
|
|
#error "lv_win: lv_label is required. Enable it in lv_conf.h (LV_USE_LABEL 1)"
|
|
#endif
|
|
|
|
#if LV_USE_IMG == 0
|
|
#error "lv_win: lv_img is required. Enable it in lv_conf.h (LV_USE_IMG 1)"
|
|
#endif
|
|
|
|
#if LV_USE_PAGE == 0
|
|
#error "lv_win: lv_page is required. Enable it in lv_conf.h (LV_USE_PAGE 1)"
|
|
#endif
|
|
|
|
#include "../lv_core/lv_obj.h"
|
|
#include "lv_cont.h"
|
|
#include "lv_btn.h"
|
|
#include "lv_label.h"
|
|
#include "lv_img.h"
|
|
#include "lv_page.h"
|
|
|
|
/*********************
|
|
* DEFINES
|
|
*********************/
|
|
|
|
/**********************
|
|
* TYPEDEFS
|
|
**********************/
|
|
|
|
/*Data of window*/
|
|
typedef struct
|
|
{
|
|
/*Ext. of ancestor*/
|
|
/*New data for this type */
|
|
lv_obj_t *page; /*Pointer to a page which holds the content*/
|
|
lv_obj_t *header; /*Pointer to the header container of the window*/
|
|
char *title_txt; /*Pointer to the title label of the window*/
|
|
lv_coord_t btn_w; /*Width of the control buttons*/
|
|
uint8_t title_txt_align; /*Control the alignment of the header text*/
|
|
} lv_win_ext_t;
|
|
|
|
/** Window parts. */
|
|
enum {
|
|
LV_WIN_PART_BG = LV_OBJ_PART_MAIN, /**< Window object background style. */
|
|
_LV_WIN_PART_VIRTUAL_LAST,
|
|
LV_WIN_PART_HEADER = _LV_OBJ_PART_REAL_LAST, /**< Window titlebar background style. */
|
|
LV_WIN_PART_CONTENT_SCROLLABLE, /**< Window content style. */
|
|
LV_WIN_PART_SCROLLBAR, /**< Window scrollbar style. */
|
|
_LV_WIN_PART_REAL_LAST
|
|
};
|
|
|
|
/**********************
|
|
* GLOBAL PROTOTYPES
|
|
**********************/
|
|
|
|
/**
|
|
* Create a window objects
|
|
* @param par pointer to an object, it will be the parent of the new window
|
|
* @param copy pointer to a window object, if not NULL then the new object will be copied from it
|
|
* @return pointer to the created window
|
|
*/
|
|
lv_obj_t *lv_win_create(lv_obj_t *par, const lv_obj_t *copy);
|
|
|
|
/**
|
|
* Delete all children of the scrl object, without deleting scrl child.
|
|
* @param win pointer to an object
|
|
*/
|
|
void lv_win_clean(lv_obj_t *win);
|
|
|
|
/*======================
|
|
* Add/remove functions
|
|
*=====================*/
|
|
|
|
/**
|
|
* Add control button on the right side of the window header
|
|
* @param win pointer to a window object
|
|
* @param img_src an image source ('lv_img_t' variable, path to file or a symbol)
|
|
* @return pointer to the created button object
|
|
*/
|
|
lv_obj_t *lv_win_add_btn_right(lv_obj_t *win, const void *img_src);
|
|
|
|
/**
|
|
* Add control button on the left side of the window header
|
|
* @param win pointer to a window object
|
|
* @param img_src an image source ('lv_img_t' variable, path to file or a symbol)
|
|
* @return pointer to the created button object
|
|
*/
|
|
lv_obj_t *lv_win_add_btn_left(lv_obj_t *win, const void *img_src);
|
|
|
|
/*=====================
|
|
* Setter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Can be assigned to a window control button to close the window
|
|
* @param btn pointer to the control button on the widows header
|
|
* @param event the event type
|
|
*/
|
|
void lv_win_close_event_cb(lv_obj_t *btn, lv_event_t event);
|
|
|
|
/**
|
|
* Set the title of a window
|
|
* @param win pointer to a window object
|
|
* @param title string of the new title
|
|
*/
|
|
void lv_win_set_title(lv_obj_t *win, const char *title);
|
|
|
|
/**
|
|
* Set the control button size of a window
|
|
* @param win pointer to a window object
|
|
* @return control button size
|
|
*/
|
|
void lv_win_set_header_height(lv_obj_t *win, lv_coord_t size);
|
|
|
|
/**
|
|
* Set the width of the control buttons on the header
|
|
* @param win pointer to a window object
|
|
* @param width width of the control button. 0: to make them square automatically.
|
|
*/
|
|
void lv_win_set_btn_width(lv_obj_t *win, lv_coord_t width);
|
|
|
|
/**
|
|
* Set the size of the content area.
|
|
* @param win pointer to a window object
|
|
* @param w width
|
|
* @param h height (the window will be higher with the height of the header)
|
|
*/
|
|
void lv_win_set_content_size(lv_obj_t *win, lv_coord_t w, lv_coord_t h);
|
|
|
|
/**
|
|
* Set the layout of the window
|
|
* @param win pointer to a window object
|
|
* @param layout the layout from 'lv_layout_t'
|
|
*/
|
|
void lv_win_set_layout(lv_obj_t *win, lv_layout_t layout);
|
|
|
|
/**
|
|
* Set the scroll bar mode of a window
|
|
* @param win pointer to a window object
|
|
* @param sb_mode the new scroll bar mode from 'lv_scrollbar_mode_t'
|
|
*/
|
|
void lv_win_set_scrollbar_mode(lv_obj_t *win, lv_scrollbar_mode_t sb_mode);
|
|
|
|
/**
|
|
* Set focus animation duration on `lv_win_focus()`
|
|
* @param win pointer to a window object
|
|
* @param anim_time duration of animation [ms]
|
|
*/
|
|
void lv_win_set_anim_time(lv_obj_t *win, uint16_t anim_time);
|
|
|
|
/**
|
|
* Set drag status of a window. If set to 'true' window can be dragged like on a PC.
|
|
* @param win pointer to a window object
|
|
* @param en whether dragging is enabled
|
|
*/
|
|
void lv_win_set_drag(lv_obj_t *win, bool en);
|
|
|
|
/**
|
|
* Set alignment of title text in window header.
|
|
* @param win pointer to a window object
|
|
* @param alignment set the type of alignment with LV_TXT_FLAGS
|
|
*/
|
|
void lv_win_title_set_alignment(lv_obj_t *win, uint8_t alignment);
|
|
|
|
/*=====================
|
|
* Getter functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Get the title of a window
|
|
* @param win pointer to a window object
|
|
* @return title string of the window
|
|
*/
|
|
const char *lv_win_get_title(const lv_obj_t *win);
|
|
|
|
/**
|
|
* Get the content holder object of window (`lv_page`) to allow additional customization
|
|
* @param win pointer to a window object
|
|
* @return the Page object where the window's content is
|
|
*/
|
|
lv_obj_t *lv_win_get_content(const lv_obj_t *win);
|
|
|
|
/**
|
|
* Get the header height
|
|
* @param win pointer to a window object
|
|
* @return header height
|
|
*/
|
|
lv_coord_t lv_win_get_header_height(const lv_obj_t *win);
|
|
|
|
/**
|
|
* Get the width of the control buttons on the header
|
|
* @param win pointer to a window object
|
|
* @return width of the control button. 0: square.
|
|
*/
|
|
lv_coord_t lv_win_get_btn_width(lv_obj_t *win);
|
|
|
|
/**
|
|
* Get the pointer of a widow from one of its control button.
|
|
* It is useful in the action of the control buttons where only button is known.
|
|
* @param ctrl_btn pointer to a control button of a window
|
|
* @return pointer to the window of 'ctrl_btn'
|
|
*/
|
|
lv_obj_t *lv_win_get_from_btn(const lv_obj_t *ctrl_btn);
|
|
|
|
/**
|
|
* Get the layout of a window
|
|
* @param win pointer to a window object
|
|
* @return the layout of the window (from 'lv_layout_t')
|
|
*/
|
|
lv_layout_t lv_win_get_layout(lv_obj_t *win);
|
|
|
|
/**
|
|
* Get the scroll bar mode of a window
|
|
* @param win pointer to a window object
|
|
* @return the scroll bar mode of the window (from 'lv_sb_mode_t')
|
|
*/
|
|
lv_scrollbar_mode_t lv_win_get_sb_mode(lv_obj_t *win);
|
|
|
|
/**
|
|
* Get focus animation duration
|
|
* @param win pointer to a window object
|
|
* @return duration of animation [ms]
|
|
*/
|
|
uint16_t lv_win_get_anim_time(const lv_obj_t *win);
|
|
|
|
/**
|
|
* Get width of the content area (page scrollable) of the window
|
|
* @param win pointer to a window object
|
|
* @return the width of the content area
|
|
*/
|
|
lv_coord_t lv_win_get_width(lv_obj_t *win);
|
|
|
|
/**
|
|
* Get drag status of a window. If set to 'true' window can be dragged like on a PC.
|
|
* @param win pointer to a window object
|
|
* @return whether window is draggable
|
|
*/
|
|
static inline bool lv_win_get_drag(const lv_obj_t *win)
|
|
{
|
|
return lv_obj_get_drag(win);
|
|
}
|
|
|
|
/**
|
|
* Get the current alignment of title text in window header.
|
|
* @param win pointer to a window object
|
|
*/
|
|
uint8_t lv_win_title_get_alignment(lv_obj_t *win);
|
|
|
|
/*=====================
|
|
* Other functions
|
|
*====================*/
|
|
|
|
/**
|
|
* Focus on an object. It ensures that the object will be visible in the window.
|
|
* @param win pointer to a window object
|
|
* @param obj pointer to an object to focus (must be in the window)
|
|
* @param anim_en LV_ANIM_ON focus with an animation; LV_ANIM_OFF focus without animation
|
|
*/
|
|
void lv_win_focus(lv_obj_t *win, lv_obj_t *obj, lv_anim_enable_t anim_en);
|
|
|
|
/**
|
|
* Scroll the window horizontally
|
|
* @param win pointer to a window object
|
|
* @param dist the distance to scroll (< 0: scroll right; > 0 scroll left)
|
|
*/
|
|
static inline void lv_win_scroll_hor(lv_obj_t *win, lv_coord_t dist)
|
|
{
|
|
lv_win_ext_t *ext = (lv_win_ext_t *)lv_obj_get_ext_attr(win);
|
|
lv_page_scroll_hor(ext->page, dist);
|
|
}
|
|
/**
|
|
* Scroll the window vertically
|
|
* @param win pointer to a window object
|
|
* @param dist the distance to scroll (< 0: scroll down; > 0 scroll up)
|
|
*/
|
|
static inline void lv_win_scroll_ver(lv_obj_t *win, lv_coord_t dist)
|
|
{
|
|
lv_win_ext_t *ext = (lv_win_ext_t *)lv_obj_get_ext_attr(win);
|
|
lv_page_scroll_ver(ext->page, dist);
|
|
}
|
|
|
|
/**********************
|
|
* MACROS
|
|
**********************/
|
|
|
|
#endif /*LV_USE_WIN*/
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /*LV_WIN_H*/
|