acid-drop

- Hacking the planet from a LilyGo T-Deck using custom firmware
git clone git://git.acid.vegas/acid-drop.git
msgbox.md (2464B)
      1 ```eval_rst
      2 .. include:: /header.rst
      3 :github_url: |github_link_base|/widgets/extra/msgbox.md
      4 ```
      5 # Message box (lv_msgbox)
      6 
      7 ## Overview
      8 The Message boxes act as pop-ups.
      9 They are built from a background container, a title, an optional close button, a text and optional buttons.
     10 
     11 The text will be broken into multiple lines automatically and the height will be set automatically to include the text and the buttons.
     12 
     13 The message box can be modal (blocking clicks on the rest of the screen) or not modal.
     14 
     15 ## Parts and Styles
     16 The message box is built from other widgets, so you can check these widgets' documentation for details.
     17 - Background: [lv_obj](/widgets/obj)
     18 - Close button: [lv_btn](/widgets/core/btn)
     19 - Title and text: [lv_label](/widgets/core/label)
     20 - Buttons: [lv_btnmatrix](/widgets/core/btnmatrix)
     21 
     22 ## Usage
     23 
     24 ### Create a message box
     25 
     26 `lv_msgbox_create(parent, title, txt, btn_txts[], add_close_btn)` creates a message box.
     27 
     28 If `parent` is `NULL` the message box will be modal. `title` and `txt` are strings for the title and the text.
     29 `btn_txts[]` is an array with the buttons' text. E.g. `const char * btn_txts[] = {"Ok", "Cancel", NULL}`.
     30 `add_close_btn` can be `true` or `false` to add/don't add a close button.
     31 
     32 ### Get the parts
     33 The building blocks of the message box can be obtained using the following functions:
     34 ```c
     35 lv_obj_t * lv_msgbox_get_title(lv_obj_t * mbox);
     36 lv_obj_t * lv_msgbox_get_close_btn(lv_obj_t * mbox);
     37 lv_obj_t * lv_msgbox_get_text(lv_obj_t * mbox);
     38 lv_obj_t * lv_msgbox_get_btns(lv_obj_t * mbox);
     39 ```
     40 
     41 ### Close the message box
     42 `lv_msgbox_close(msgbox)` closes (deletes) the message box.
     43 
     44 ## Events
     45 - `LV_EVENT_VALUE_CHANGED` is sent by the buttons if one of them is clicked. `LV_OBJ_FLAG_EVENT_BUBBLE` is enabled on the buttons so you can add events to the message box itself.
     46 In the event handler, `lv_event_get_target(e)` will return the button matrix and `lv_event_get_current_target(e)` will return the message box. `lv_msgbox_get_active_btn(msgbox)` and `lv_msgbox_get_active_btn_text(msgbox)` can be used to get the index and text of the clicked button.
     47 
     48 Learn more about [Events](/overview/event).
     49 
     50 ## Keys
     51 Keys have effect on the close button and button matrix. You can add them manually to a group if required.
     52 
     53 Learn more about [Keys](/overview/indev).
     54 
     55 
     56 ## Example
     57 
     58 ```eval_rst
     59 
     60 .. include:: ../../../examples/widgets/msgbox/index.rst
     61 
     62 ```
     63 
     64 ## API
     65 
     66 ```eval_rst
     67 
     68 .. doxygenfile:: lv_msgbox.h
     69   :project: lvgl
     70 
     71 ```