¶
luxe API (2025.1.2)¶
luxe: ui/block module¶
- BlockListener
- ModifiedPip
- UIBlock
- UIBlockAssetEvent
- UIBlockChange
- UIBlockChangeType
- UIBlockEventType
- UIBlockLinkEvent
- UIBlockState
BlockListener¶
import "luxe: ui/block" for BlockListener
no docs found
Block
no docs found
Handle
no docs found
Block, handle: Handle)
¶BlockListener
no docs found
ModifiedPip¶
import "luxe: ui/block" for ModifiedPip
no docs found
Control
no docs found
BlockFieldModified
no docs found
unknown
no docs found
unknown
no docs found
UI, kind: BlockFieldModified)
¶ModifiedPip
no docs found
UIBlock¶
import "luxe: ui/block" for UIBlock
no docs found
- create(ui:
Entity) - set_block_instance(control:
Control, block:Block, instance:BlockInstance) - set_block_instances(control:
Control, block:Block, instances:List) - set_blocks_instances(control:
Control, blocks:List, instances:List) - set_sizes(control:
Control, label_width:Num, label_size:Num, field_height:Num) - refresh(control:
Control) - get_handle_assets(control:
Control) - set_handle_assets(control:
Control, yes:Bool) - set_show_defaults(control:
Control, yes:Bool) - get_block_fields(control:
Any)
Entity)
¶unknown
no docs found
Control, block: Block, instance: BlockInstance)
¶unknown
no docs found
Control, block: Block, instances: List)
¶unknown
no docs found
Control, blocks: List, instances: List)
¶unknown
no docs found
Control, label_width: Num, label_size: Num, field_height: Num)
¶unknown
no docs found
Control)
¶unknown
no docs found
Control)
¶Bool
no docs found
Control, yes: Bool)
¶None
no docs found
Control, yes: Bool)
¶unknown
no docs found
Any)
¶Map
no docs found
UIBlockAssetEvent¶
import "luxe: ui/block" for UIBlockAssetEvent
no docs found
List
no docs found
String
no docs found
List, original_in: String, fn: Fn)
¶UIBlockAssetEvent
no docs found
String)
¶unknown
no docs found
UIBlockChange¶
import "luxe: ui/block" for UIBlockChange
A change in the block ui can inside a nested block, each with it's own individual instance, list of nested fields, and list of nested array index values each step down. This tracks that for changes.
var change_id : Any = null- new(kind:
UIBlockChangeType, root:Block, root_instance:BlockInstance, blocks:List, instances:List, fields:List, indices:List, edit_value:Any) - refresh()
- handle()
- set_refresh(fn:
Fn) - set_handler(fn:
Fn) - kind
- block
- instance
- blocks
- instances
- field
- array_indices
- field_index(idx:
Num) - default
- get_field_value()
- get_leaf_value()
- leaf_block
- leaf_instance
- leaf_field_index
- leaf_array_index
- get_change_value()
- field_is_array()
- field_is_object()
- value
- edit_value
UIBlockChangeType, root: Block, root_instance: BlockInstance, blocks: List, instances: List, fields: List, indices: List, edit_value: Any)
¶UIBlockChange
no docs found
unknown
no docs found
unknown
no docs found
Fn)
¶unknown
no docs found
Fn)
¶unknown
no docs found
UIBlockChangeType
The type of change event
Block
The root block in which the change occurred
Num
The instance of the root block
List
The list of blocks down the chain e.g some.nested.field
List
The list of instances for each block down the chain e.g some.nested.field
List
The list of nested fields for each block, e.g some.nested.field -> ["some", "nested", "field"]
Num
The array index for each nested block. e.g some.nested[2].block[3] is [0, 2, 3]
Num)
¶Num
The field index for the field in the fields list. e.g ["some", "nested", "field"] -> field_index[1] returns the field index of nested in the second block down
Any
The default value in the leaf block for this field
Any
The current value in the leaf block for this field (e.g for an array, returns the contents of the array)
Any
The current value in the leaf for this block/field/array?
Block
no docs found
BlockInstance
no docs found
Num
no docs found
Num
no docs found
Any
no docs found
Bool
no docs found
Bool
no docs found
Any
The intended change value based on type
Any
The value from the ui at the time of the change
UIBlockChangeType¶
import "luxe: ui/block" for UIBlockChangeType
no docs found
unknown
no docs found
unknown
no docs found
unknown
no docs found
unknown
no docs found
unknown
no docs found
unknown
no docs found
unknown
no docs found
unknown
no docs found
unknown
no docs found
UIBlockEventType¶
import "luxe: ui/block" for UIBlockEventType
no docs found
unknown
no docs found
unknown
no docs found
UIBlockLinkEvent¶
import "luxe: ui/block" for UIBlockLinkEvent
no docs found
- original
- tag
- from_drop
- drop_payload
- new(original_in:
List, tag:ID32, fn:Fn) - new(original_in:
List, tag:ID32, drop_payload:Handle, fn:Fn) - done(value:
List)
List
no docs found
String
no docs found
Bool
no docs found
Bool
no docs found
List, tag: ID32, fn: Fn)
¶UIBlockLinkEvent
no docs found
List, tag: ID32, drop_payload: Handle, fn: Fn)
¶UIBlockLinkEvent
no docs found
List)
¶unknown
no docs found
UIBlockState¶
import "luxe: ui/block" for UIBlockState
no docs found
- new(ui:
Entity, control:Control) - get_block_fields()
- set_show_defaults(show_defaults:
Any) - clear_listeners()
- handle_assets
- handle_assets=(v : Bool)
- field_h
- label_w
- set_sizes(label_width:
Num, label_size:Num, field_height:Num) - set_instance(block:
Block, instance:BlockInstance) - set_instances(block:
Block, instances:List) - set_blocks_instances(blocks:
List, instances:List) - do_refresh()
- refresh()
- make_vec(view:
ValueView) - make_color(view:
ValueView) - make_num(view:
ValueView) - make_text(view:
ValueView) - get_asset_picks(types:
Any) - make_asset(view:
ValueView) - make_link(view:
ValueView) - make_path(view:
ValueView, tag:Num) - make_empty_object(name:
String) - make_empty_object(name:
String, display:String) - make_multiple_message()
- make_message(display:
String) - make_bool(default:
Bool) - make_options(options:
List, default:String) - make_object_field(name:
String, view:ValueView) - make_options_field(view:
ValueView) - make_field(name:
String, type:BlockFieldType, view:ValueView) - make_object(name:
String) - make_object(name:
String, title_color:Color) - make_object(name:
String, details:String, title_color:Color) - make_label(name:
String, width:Num) - p(depth:
Any, value:Any) - dump_info(control:
Control, d:Num) - make_mod_pip(kind:
BlockFieldModified) - get_changes(kind:
UIBlockChange, value:ValueView, edit_value:Any) - get_changes(kind:
UIBlockChange, value:ValueView, edit_value:Any, edit_value_fn:Fn) - get_changes(kind:
UIBlockChange, value:ValueView, change_id:String, edit_value:Any, edit_value_fn:Fn) - make_block(instance_view:
InstanceView, into:Control) - make_block(instance_view:
InstanceView, into:Control, indent:Num) - hide_tip(from:
Control) - show_tip(tooltip:
String, control:Control) - make_group(name:
Any)
Entity, control: Control)
¶UIBlockState
no docs found
unknown
no docs found
Any)
¶unknown
no docs found
unknown
no docs found
Bool
no docs found
unknown
no docs found
unknown
no docs found
unknown
no docs found
Num, label_size: Num, field_height: Num)
¶unknown
no docs found
Block, instance: BlockInstance)
¶unknown
no docs found
Block, instances: List)
¶unknown
no docs found
List, instances: List)
¶unknown
no docs found
unknown
no docs found
unknown
no docs found
ValueView)
¶Field
no docs found
ValueView)
¶Field
no docs found
ValueView)
¶Field
no docs found
ValueView)
¶Field
no docs found
Any)
¶unknown
no docs found
ValueView)
¶Field
no docs found
ValueView)
¶Field
no docs found
ValueView, tag: Num)
¶Field
no docs found
String)
¶Field
no docs found
String, display: String)
¶Field
no docs found
unknown
no docs found
String)
¶unknown
no docs found
Bool)
¶Field
no docs found
List, default: String)
¶Field
no docs found
String, view: ValueView)
¶unknown
no docs found
ValueView)
¶Field
no docs found
String, type: BlockFieldType, view: ValueView)
¶Field
no docs found
String)
¶unknown
no docs found
String, title_color: Color)
¶unknown
no docs found
String, details: String, title_color: Color)
¶unknown
no docs found
String, width: Num)
¶unknown
no docs found
Any, value: Any)
¶unknown
no docs found
Control, d: Num)
¶unknown
no docs found
BlockFieldModified)
¶ModifiedPip
no docs found
UIBlockChange, value: ValueView, edit_value: Any)
¶List
no docs found
UIBlockChange, value: ValueView, edit_value: Any, edit_value_fn: Fn)
¶List
no docs found
UIBlockChange, value: ValueView, change_id: String, edit_value: Any, edit_value_fn: Fn)
¶List
no docs found
InstanceView, into: Control)
¶unknown
no docs found
InstanceView, into: Control, indent: Num)
¶unknown
no docs found
Control)
¶unknown
no docs found
String, control: Control)
¶unknown
no docs found
Any)
¶unknown
no docs found