class textbox

Declaration

class textbox : public abstract, public std::vector { /* full declaration omitted */ };

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:32

Inherits from: abstract, std::vector

Member Variables

protected ekg::font font_size = {}
protected std::string formatted_text = {}
protected bool enabled = {}
protected bool must_format_text = {}
protected uint8_t tab_size = {4}
protected uint64_t max_lines = {(4294967295U)}
protected uint64_t max_chars_per_line = {(4294967295U)}

Inherited from abstract:

protected action_register = {}
protected layer_surfaces = {}
protected id = {}
protected parent_id = {}
protected owner_id = {}
protected child_id_list = {}
protected alive = {true}
protected visible = {true}
protected immutable = {}
protected dock_flags = {}
protected sync_flags = {}
protected tag = {}
protected state = {}
protected type = {ekg::type::abstract}
protected level = {}
protected rect_widget = {}
protected sync_ui = {}
protected scaled_height = {}

Method Overview

Inherited from abstract:

Methods

ekg::font get_font_size()

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:57

float get_height()

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:69

uint64_t get_max_chars_per_line()

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:84

uint64_t get_max_lines()

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:88

int32_t get_scaled_height()

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:61

uint8_t get_tab_size()

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:80

std::string get_text()

Description

Return formatted text from text box content. if `must_format_text` is true, then re-format the text, and automatically set `must_format_text` to false.

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:76

float get_width()

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:65

bool is_must_format_text()

Description

Return UI `must_format_text` value.

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:53

ekg::ui::textbox* set_font_size(ekg::font font)

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:55

Parameters

ekg::font font

ekg::ui::textbox* set_max_chars_per_line(
    uint64_t chars_per_line)

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:82

Parameters

uint64_t chars_per_line

ekg::ui::textbox* set_max_lines(uint64_t lines)

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:86

Parameters

uint64_t lines

ekg::ui::textbox* set_must_format_text(bool state)

Description

Set UI `must_format_text` value. If true `ekg::ui::listbox::get_text` re-format the content, else false content is not re-formatted.

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:48

Parameters

bool state

ekg::ui::textbox* set_place(uint16_t dock)

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:59

Parameters

uint16_t dock

ekg::ui::textbox* set_scaled_height(int32_t h)

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:67

Parameters

int32_t h

ekg::ui::textbox* set_tab_size(uint8_t size)

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:78

Parameters

uint8_t size

ekg::ui::textbox* set_width(float w)

Declared at: include/ekg/ui/textbox/ui_textbox.hpp:63

Parameters

float w