# {py:mod}`simvx.core.ui.command_line`

```{py:module} simvx.core.ui.command_line
```

```{autodoc2-docstring} simvx.core.ui.command_line
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`CommandLine <simvx.core.ui.command_line.CommandLine>`
  - ```{autodoc2-docstring} simvx.core.ui.command_line.CommandLine
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <simvx.core.ui.command_line.__all__>`
  - ```{autodoc2-docstring} simvx.core.ui.command_line.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.ui.command_line.__all__
:value: >
   ['CommandLine']

```{autodoc2-docstring} simvx.core.ui.command_line.__all__
```

````

`````{py:class} CommandLine(text: str = '', placeholder: str = '', **kwargs)
:canonical: simvx.core.ui.command_line.CommandLine

Bases: {py:obj}`simvx.core.ui.widgets.TextEdit`

```{autodoc2-docstring} simvx.core.ui.command_line.CommandLine
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.command_line.CommandLine.__init__
```

````{py:attribute} max_history
:canonical: simvx.core.ui.command_line.CommandLine.max_history
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.ui.command_line.CommandLine.max_history
```

````

````{py:property} history
:canonical: simvx.core.ui.command_line.CommandLine.history
:type: tuple[str, ...]

```{autodoc2-docstring} simvx.core.ui.command_line.CommandLine.history
```

````

````{py:attribute} pointer_filter
:canonical: simvx.core.ui.command_line.CommandLine.pointer_filter
:value: >
   'Property(...)'

````

````{py:attribute} cursor_shape
:canonical: simvx.core.ui.command_line.CommandLine.cursor_shape
:value: >
   'Property(...)'

````

````{py:attribute} touch_target
:canonical: simvx.core.ui.command_line.CommandLine.touch_target
:value: >
   True

````

````{py:property} wants_text_input
:canonical: simvx.core.ui.command_line.CommandLine.wants_text_input
:type: bool

````

````{py:attribute} text
:canonical: simvx.core.ui.command_line.CommandLine.text
:value: >
   'Property(...)'

````

````{py:attribute} placeholder
:canonical: simvx.core.ui.command_line.CommandLine.placeholder
:value: >
   'Property(...)'

````

````{py:attribute} max_length
:canonical: simvx.core.ui.command_line.CommandLine.max_length
:value: >
   'Property(...)'

````

````{py:attribute} focus_mode
:canonical: simvx.core.ui.command_line.CommandLine.focus_mode
:value: >
   'Property(...)'

````

````{py:attribute} size_x
:canonical: simvx.core.ui.command_line.CommandLine.size_x
:value: >
   'Property(...)'

````

````{py:attribute} size_y
:canonical: simvx.core.ui.command_line.CommandLine.size_y
:value: >
   'Property(...)'

````

````{py:attribute} text_colour
:canonical: simvx.core.ui.command_line.CommandLine.text_colour
:value: >
   'ThemeColour(...)'

````

````{py:attribute} placeholder_colour
:canonical: simvx.core.ui.command_line.CommandLine.placeholder_colour
:value: >
   'ThemeColour(...)'

````

````{py:attribute} selection_colour
:canonical: simvx.core.ui.command_line.CommandLine.selection_colour
:value: >
   'ThemeColour(...)'

````

````{py:attribute} style_normal
:canonical: simvx.core.ui.command_line.CommandLine.style_normal
:value: >
   'ThemeStyleBox(...)'

````

````{py:attribute} style_focused
:canonical: simvx.core.ui.command_line.CommandLine.style_focused
:value: >
   'ThemeStyleBox(...)'

````

````{py:attribute} style_disabled
:canonical: simvx.core.ui.command_line.CommandLine.style_disabled
:value: >
   'ThemeStyleBox(...)'

````

````{py:method} get_minimum_size() -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.command_line.CommandLine.get_minimum_size

````

````{py:method} select_all() -> None
:canonical: simvx.core.ui.command_line.CommandLine.select_all

````

````{py:method} insert(text: str) -> None
:canonical: simvx.core.ui.command_line.CommandLine.insert

````

````{py:method} on_gui_input(event)
:canonical: simvx.core.ui.command_line.CommandLine.on_gui_input

````

````{py:method} on_update(dt: float)
:canonical: simvx.core.ui.command_line.CommandLine.on_update

````

````{py:method} on_draw(renderer)
:canonical: simvx.core.ui.command_line.CommandLine.on_draw

````

````{py:method} copy() -> None
:canonical: simvx.core.ui.command_line.CommandLine.copy

````

````{py:method} cut() -> None
:canonical: simvx.core.ui.command_line.CommandLine.cut

````

````{py:method} paste() -> None
:canonical: simvx.core.ui.command_line.CommandLine.paste

````

````{py:attribute} min_size_x
:canonical: simvx.core.ui.command_line.CommandLine.min_size_x
:value: >
   'Property(...)'

````

````{py:attribute} min_size_y
:canonical: simvx.core.ui.command_line.CommandLine.min_size_y
:value: >
   'Property(...)'

````

````{py:attribute} anchor_left
:canonical: simvx.core.ui.command_line.CommandLine.anchor_left
:value: >
   'Property(...)'

````

````{py:attribute} anchor_top
:canonical: simvx.core.ui.command_line.CommandLine.anchor_top
:value: >
   'Property(...)'

````

````{py:attribute} anchor_right
:canonical: simvx.core.ui.command_line.CommandLine.anchor_right
:value: >
   'Property(...)'

````

````{py:attribute} anchor_bottom
:canonical: simvx.core.ui.command_line.CommandLine.anchor_bottom
:value: >
   'Property(...)'

````

````{py:attribute} margin_left
:canonical: simvx.core.ui.command_line.CommandLine.margin_left
:value: >
   'Property(...)'

````

````{py:attribute} margin_top
:canonical: simvx.core.ui.command_line.CommandLine.margin_top
:value: >
   'Property(...)'

````

````{py:attribute} margin_right
:canonical: simvx.core.ui.command_line.CommandLine.margin_right
:value: >
   'Property(...)'

````

````{py:attribute} margin_bottom
:canonical: simvx.core.ui.command_line.CommandLine.margin_bottom
:value: >
   'Property(...)'

````

````{py:attribute} anchor
:canonical: simvx.core.ui.command_line.CommandLine.anchor
:value: >
   'Property(...)'

````

````{py:attribute} inset
:canonical: simvx.core.ui.command_line.CommandLine.inset
:value: >
   'Property(...)'

````

````{py:attribute} dismiss_on_outside_click
:canonical: simvx.core.ui.command_line.CommandLine.dismiss_on_outside_click
:value: >
   'Property(...)'

````

````{py:attribute} clip_contents
:canonical: simvx.core.ui.command_line.CommandLine.clip_contents
:value: >
   'Property(...)'

````

````{py:attribute} tooltip
:canonical: simvx.core.ui.command_line.CommandLine.tooltip
:value: >
   'Property(...)'

````

````{py:attribute} pointer_types
:canonical: simvx.core.ui.command_line.CommandLine.pointer_types
:type: frozenset[simvx.core.input.enums.PointerType] | None
:value: >
   None

````

````{py:attribute} size_flags_horizontal
:canonical: simvx.core.ui.command_line.CommandLine.size_flags_horizontal
:value: >
   'Property(...)'

````

````{py:attribute} size_flags_vertical
:canonical: simvx.core.ui.command_line.CommandLine.size_flags_vertical
:value: >
   'Property(...)'

````

````{py:attribute} stretch_ratio
:canonical: simvx.core.ui.command_line.CommandLine.stretch_ratio
:value: >
   'Property(...)'

````

````{py:attribute} max_size
:canonical: simvx.core.ui.command_line.CommandLine.max_size
:value: >
   'Property(...)'

````

````{py:property} size
:canonical: simvx.core.ui.command_line.CommandLine.size
:type: simvx.core.math.types.Vec2

````

````{py:property} min_size
:canonical: simvx.core.ui.command_line.CommandLine.min_size
:type: simvx.core.math.types.Vec2

````

````{py:method} content_signature() -> object
:canonical: simvx.core.ui.command_line.CommandLine.content_signature

````

````{py:method} content_uses(chars: str) -> bool
:canonical: simvx.core.ui.command_line.CommandLine.content_uses

````

````{py:method} autosize_to_content() -> None
:canonical: simvx.core.ui.command_line.CommandLine.autosize_to_content

````

````{py:attribute} accepts_pointers
:canonical: simvx.core.ui.command_line.CommandLine.accepts_pointers
:value: >
   'Property(...)'

````

````{py:property} theme
:canonical: simvx.core.ui.command_line.CommandLine.theme
:type: simvx.core.ui.types.Theme | None

````

````{py:property} mouse_over
:canonical: simvx.core.ui.command_line.CommandLine.mouse_over
:type: bool

````

````{py:property} disabled
:canonical: simvx.core.ui.command_line.CommandLine.disabled
:type: bool

````

````{py:method} get_theme() -> simvx.core.ui.types.Theme
:canonical: simvx.core.ui.command_line.CommandLine.get_theme

````

````{py:property} viewport_size
:canonical: simvx.core.ui.command_line.CommandLine.viewport_size
:type: simvx.core.math.types.Vec2

````

````{py:property} viewport_insets
:canonical: simvx.core.ui.command_line.CommandLine.viewport_insets
:type: tuple[float, float, float, float]

````

````{py:method} queue_redraw()
:canonical: simvx.core.ui.command_line.CommandLine.queue_redraw

````

````{py:method} size_floor() -> tuple[float, float]
:canonical: simvx.core.ui.command_line.CommandLine.size_floor

````

````{py:method} add_child(node: simvx.core.node.T) -> simvx.core.node.T
:canonical: simvx.core.ui.command_line.CommandLine.add_child

````

````{py:method} get_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.command_line.CommandLine.get_rect

````

````{py:method} get_global_rect() -> tuple[float, float, float, float]
:canonical: simvx.core.ui.command_line.CommandLine.get_global_rect

````

````{py:property} focus_rect
:canonical: simvx.core.ui.command_line.CommandLine.focus_rect
:type: tuple[float, float, float, float] | None

````

````{py:method} is_point_inside(point) -> bool
:canonical: simvx.core.ui.command_line.CommandLine.is_point_inside

````

````{py:method} is_hit(event: simvx.core.input.events.PointerEvent) -> bool
:canonical: simvx.core.ui.command_line.CommandLine.is_hit

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.ui.command_line.CommandLine.__init_subclass__
:classmethod:

````

````{py:method} activate() -> bool
:canonical: simvx.core.ui.command_line.CommandLine.activate

````

````{py:method} focus_next_control()
:canonical: simvx.core.ui.command_line.CommandLine.focus_next_control

````

````{py:method} focus_previous_control()
:canonical: simvx.core.ui.command_line.CommandLine.focus_previous_control

````

````{py:method} set_drag_preview(control: simvx.core.ui.core.Control)
:canonical: simvx.core.ui.command_line.CommandLine.set_drag_preview

````

````{py:property} is_overlay_open
:canonical: simvx.core.ui.command_line.CommandLine.is_overlay_open
:type: bool

````

````{py:method} show_overlay(modality: str = 'light', *, dim: bool | None = None, dismiss: bool | None = None, inert: bool | None = None, owner: simvx.core.ui.core.Control | None = None, initial_focus: simvx.core.ui.core.Control | None = None) -> None
:canonical: simvx.core.ui.command_line.CommandLine.show_overlay

````

````{py:method} close_overlay() -> None
:canonical: simvx.core.ui.command_line.CommandLine.close_overlay

````

````{py:attribute} position
:canonical: simvx.core.ui.command_line.CommandLine.position
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} rotation
:canonical: simvx.core.ui.command_line.CommandLine.rotation
:value: >
   'Property(...)'

````

````{py:attribute} scale
:canonical: simvx.core.ui.command_line.CommandLine.scale
:value: >
   '_SpatialVecProperty(...)'

````

````{py:attribute} top_level
:canonical: simvx.core.ui.command_line.CommandLine.top_level
:value: >
   'Property(...)'

````

````{py:attribute} z_index
:canonical: simvx.core.ui.command_line.CommandLine.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.ui.command_line.CommandLine.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.ui.command_line.CommandLine.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.ui.command_line.CommandLine.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.ui.command_line.CommandLine.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.ui.command_line.CommandLine.absolute_z_index
:type: int

````

````{py:property} rotation_degrees
:canonical: simvx.core.ui.command_line.CommandLine.rotation_degrees
:type: float

````

````{py:property} world_position
:canonical: simvx.core.ui.command_line.CommandLine.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.ui.command_line.CommandLine.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.ui.command_line.CommandLine.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_transform
:canonical: simvx.core.ui.command_line.CommandLine.world_transform
:type: tuple[simvx.core.math.types.Vec2, simvx.core.math.types.Vec2, float]

````

````{py:property} forward
:canonical: simvx.core.ui.command_line.CommandLine.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.ui.command_line.CommandLine.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.command_line.CommandLine.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.ui.command_line.CommandLine.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.ui.command_line.CommandLine.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.ui.command_line.CommandLine.look_at

````

````{py:method} to_global(point) -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.command_line.CommandLine.to_global

````

````{py:method} to_local(point) -> simvx.core.math.types.Vec2
:canonical: simvx.core.ui.command_line.CommandLine.to_local

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.ui.command_line.CommandLine.transform_points

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.ui.command_line.CommandLine.wrap_screen

````

````{py:attribute} post_processed
:canonical: simvx.core.ui.command_line.CommandLine.post_processed
:value: >
   'Property(...)'

````

````{py:property} transform_render_dirty
:canonical: simvx.core.ui.command_line.CommandLine.transform_render_dirty
:type: bool

````

````{py:attribute} strict_errors
:canonical: simvx.core.ui.command_line.CommandLine.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} dev_checks
:canonical: simvx.core.ui.command_line.CommandLine.dev_checks
:type: typing.ClassVar[bool]
:value: >
   None

````

````{py:attribute} dev_warnings
:canonical: simvx.core.ui.command_line.CommandLine.dev_warnings
:type: typing.ClassVar[bool]
:value: >
   None

````

````{py:attribute} freeze_check_interval
:canonical: simvx.core.ui.command_line.CommandLine.freeze_check_interval
:type: typing.ClassVar[float]
:value: >
   1.0

````

````{py:attribute} dynamic
:canonical: simvx.core.ui.command_line.CommandLine.dynamic
:type: bool
:value: >
   False

````

````{py:attribute} visible
:canonical: simvx.core.ui.command_line.CommandLine.visible
:value: >
   'Property(...)'

````

````{py:attribute} update_mode
:canonical: simvx.core.ui.command_line.CommandLine.update_mode
:value: >
   'Property(...)'

````

````{py:attribute} drag_threshold
:canonical: simvx.core.ui.command_line.CommandLine.drag_threshold
:value: >
   'Property(...)'

````

````{py:attribute} focus_entered
:canonical: simvx.core.ui.command_line.CommandLine.focus_entered
:value: >
   'Signal(...)'

````

````{py:attribute} focus_exited
:canonical: simvx.core.ui.command_line.CommandLine.focus_exited
:value: >
   'Signal(...)'

````

````{py:attribute} __properties__
:canonical: simvx.core.ui.command_line.CommandLine.__properties__
:type: typing.ClassVar[dict[str, simvx.core.descriptors.Property]]
:value: >
   None

````

````{py:property} name
:canonical: simvx.core.ui.command_line.CommandLine.name
:type: str

````

````{py:property} visible_in_tree
:canonical: simvx.core.ui.command_line.CommandLine.visible_in_tree
:type: bool

````

````{py:property} input_player
:canonical: simvx.core.ui.command_line.CommandLine.input_player
:type: simvx.core.input.players.InputPlayer

````

````{py:property} input_context
:canonical: simvx.core.ui.command_line.CommandLine.input_context
:type: simvx.core.input.contexts.InputContext | None

````

````{py:method} reset_error() -> None
:canonical: simvx.core.ui.command_line.CommandLine.reset_error

````

````{py:method} remove_child(node: simvx.core.node.Node) -> None
:canonical: simvx.core.ui.command_line.CommandLine.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.ui.command_line.CommandLine.reparent

````

````{py:method} node_at(path, default=_NO_DEFAULT)
:canonical: simvx.core.ui.command_line.CommandLine.node_at

````

````{py:method} find(target, *, direct: bool = False)
:canonical: simvx.core.ui.command_line.CommandLine.find

````

````{py:method} find_all(target, *, direct: bool = False)
:canonical: simvx.core.ui.command_line.CommandLine.find_all

````

````{py:method} expect(target, *, direct: bool = False)
:canonical: simvx.core.ui.command_line.CommandLine.expect

````

````{py:method} ancestor(target)
:canonical: simvx.core.ui.command_line.CommandLine.ancestor

````

````{py:method} walk(*, include_self: bool = True) -> collections.abc.Iterator[simvx.core.node.Node]
:canonical: simvx.core.ui.command_line.CommandLine.walk

````

````{py:property} path
:canonical: simvx.core.ui.command_line.CommandLine.path
:type: str

````

````{py:property} is_scene_root
:canonical: simvx.core.ui.command_line.CommandLine.is_scene_root
:type: bool

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.ui.command_line.CommandLine.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.ui.command_line.CommandLine.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.ui.command_line.CommandLine.is_in_group

````

````{py:method} on_ready() -> None
:canonical: simvx.core.ui.command_line.CommandLine.on_ready

````

````{py:method} on_enter_tree() -> None
:canonical: simvx.core.ui.command_line.CommandLine.on_enter_tree

````

````{py:method} on_exit_tree() -> None
:canonical: simvx.core.ui.command_line.CommandLine.on_exit_tree

````

````{py:method} on_fixed_update(dt: float) -> None
:canonical: simvx.core.ui.command_line.CommandLine.on_fixed_update

````

````{py:method} on_draw_3d(gizmos) -> None
:canonical: simvx.core.ui.command_line.CommandLine.on_draw_3d

````

````{py:method} on_picked(event: simvx.core.input.events.PickEvent) -> bool | None
:canonical: simvx.core.ui.command_line.CommandLine.on_picked

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.ui.command_line.CommandLine.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.ui.command_line.CommandLine.stop_coroutine

````

````{py:property} focused
:canonical: simvx.core.ui.command_line.CommandLine.focused
:type: bool

````

````{py:method} drag_threshold_for(pointer_type: simvx.core.input.enums.PointerType | str) -> float
:canonical: simvx.core.ui.command_line.CommandLine.drag_threshold_for

````

````{py:method} grab_focus() -> None
:canonical: simvx.core.ui.command_line.CommandLine.grab_focus

````

````{py:method} release_focus() -> None
:canonical: simvx.core.ui.command_line.CommandLine.release_focus

````

````{py:method} capture_pointer(pointer_id: int | None = None) -> None
:canonical: simvx.core.ui.command_line.CommandLine.capture_pointer

````

````{py:method} release_pointer(pointer_id: int | None = None) -> None
:canonical: simvx.core.ui.command_line.CommandLine.release_pointer

````

````{py:property} render_dirty
:canonical: simvx.core.ui.command_line.CommandLine.render_dirty
:type: bool

````

````{py:method} clear_children()
:canonical: simvx.core.ui.command_line.CommandLine.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.ui.command_line.CommandLine.destroy

````

````{py:property} destroying
:canonical: simvx.core.ui.command_line.CommandLine.destroying
:type: bool

````

````{py:property} destroyed
:canonical: simvx.core.ui.command_line.CommandLine.destroyed
:type: bool

````

````{py:method} call_deferred(method: collections.abc.Callable[..., typing.Any], *args: typing.Any) -> None
:canonical: simvx.core.ui.command_line.CommandLine.call_deferred

````

````{py:property} app
:canonical: simvx.core.ui.command_line.CommandLine.app

````

````{py:property} tree
:canonical: simvx.core.ui.command_line.CommandLine.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:property} physics
:canonical: simvx.core.ui.command_line.CommandLine.physics

````

````{py:property} physics_2d
:canonical: simvx.core.ui.command_line.CommandLine.physics_2d

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.ui.command_line.CommandLine.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.ui.command_line.CommandLine.get_properties
:classmethod:

````

````{py:method} __repr__()
:canonical: simvx.core.ui.command_line.CommandLine.__repr__

````

`````