glendix/define/ui

Renders screens for the interactive Glendix widget definition editor.

Types

ChangeState

Represents whether the editor has unsaved changes.

pub type ChangeState {
  Saved
  Modified
}

Constructors

```
Saved
```
The rendered model is saved.
```
Modified
```
The rendered model contains unsaved changes.

EditField

</>

A typed EditField value used by the ui capability.

pub type EditField {
  TextField(label: String, value: String)
  BoolField(label: String, value: Bool)
  ReadOnlyField(label: String, value: String)
  ListField(label: String, count: Int)
  SelectField(label: String, value: String)
}

Constructors

```
TextField(label: String, value: String)
```
The TextField variant.
```
BoolField(label: String, value: Bool)
```
The BoolField variant.

ReadOnlyField(label: String, value: String)

The ReadOnlyField variant.

```
ListField(label: String, count: Int)
```
The ListField variant.

SelectField(label: String, value: String)

The SelectField variant.

EditMode

</>

Represents whether a text field is actively being edited.

pub type EditMode {
  Viewing
  Editing
}

Constructors

```
Viewing
```
The field is displayed without an active text cursor.
```
Editing
```
The field is displayed with an active text cursor.

TreeRow

</>

A typed TreeRow value used by the ui capability.

pub type TreeRow {
  GroupRow(
    flat_index: Int,
    group_index: Int,
    caption: String,
    item_count: Int,
    is_collapsed: Bool,
  )
  PropertyRow(
    flat_index: Int,
    group_index: Int,
    item_index: Int,
    prop: model.Property,
  )
  SystemRow(
    flat_index: Int,
    group_index: Int,
    item_index: Int,
    key: String,
  )
}

Constructors

GroupRow(
  flat_index: Int,
  group_index: Int,
  caption: String,
  item_count: Int,
  is_collapsed: Bool,
)

The GroupRow variant.

PropertyRow(
  flat_index: Int,
  group_index: Int,
  item_index: Int,
  prop: model.Property,
)

The PropertyRow variant.

SystemRow(
  flat_index: Int,
  group_index: Int,
  item_index: Int,
  key: String,
)

The SystemRow variant.

Values

build_tree_rows

</>

pub fn build_tree_rows(
  groups groups: List(model.PropertyGroup),
  collapsed collapsed: List(Int),
  group_start group_start: Int,
  flat_start flat_start: Int,
) -> List(TreeRow)

Builds the tree rows.

fields_to_property

</>

pub fn fields_to_property(
  original original: model.Property,
  fields fields: List(EditField),
) -> model.Property

Applies edited form fields to a property.

fields_to_widget_meta

</>

pub fn fields_to_widget_meta(
  original original: model.WidgetMeta,
  fields fields: List(EditField),
) -> model.WidgetMeta

Applies edited form fields to widget metadata.

property_to_fields

</>

pub fn property_to_fields(
  prop prop: model.Property,
) -> List(EditField)

Converts a property into editable form fields.

render_confirm_delete_screen

</>

pub fn render_confirm_delete_screen(
  target_label target_label: String,
) -> String

Renders the confirm delete screen.

render_confirm_quit_screen

</>

pub fn render_confirm_quit_screen() -> String

Renders the confirm quit screen.

render_edit_screen

</>

pub fn render_edit_screen(
  prop_key prop_key: String,
  prop_type prop_type: String,
  fields fields: List(EditField),
  cursor cursor: Int,
  mode mode: EditMode,
  edit_buffer edit_buffer: String,
  edit_cursor_pos edit_cursor_pos: Int,
) -> String

Renders the edit screen.

render_enum_edit_screen

</>

pub fn render_enum_edit_screen(
  values values: List(model.EnumValue),
  cursor cursor: Int,
  status_msg status_msg: option.Option(String),
) -> String

Renders the enum edit screen.

render_input_screen

</>

pub fn render_input_screen(
  title title: String,
  buffer buffer: String,
  cursor_pos cursor_pos: Int,
) -> String

Renders the input screen.

render_multi_select_screen

</>

pub fn render_multi_select_screen(
  title title: String,
  options options: List(String),
  selected selected: List(String),
  cursor cursor: Int,
) -> String

Renders the multi select screen.

render_sys_prop_screen

</>

pub fn render_sys_prop_screen(
  options options: List(String),
  cursor cursor: Int,
) -> String

Renders the sys prop screen.

render_tree_screen

</>

pub fn render_tree_screen(
  widget_name widget_name: String,
  groups groups: List(model.PropertyGroup),
  cursor cursor: Int,
  collapsed collapsed: List(Int),
  changes changes: ChangeState,
  status_msg status_msg: option.Option(String),
  scroll_offset scroll_offset: Int,
  term_rows term_rows: Int,
) -> String

Renders the tree screen.

render_type_select_screen

</>

pub fn render_type_select_screen(cursor cursor: Int) -> String

Renders the type select screen.

widget_meta_to_fields

</>

pub fn widget_meta_to_fields(
  meta meta: model.WidgetMeta,
) -> List(EditField)

Converts widget metadata into editable form fields.