Struct InputContext 

pub struct InputContext { /* private fields */ }

What the view does with the keys, as the keys before the one being done left it, in TuiKeys, and as the frame’s keys left it, after them: for a filter that acts only in some states, such as not while a completion is open. The view writes it; it is read-only to plugins.

Implementations

impl InputContext

pub fn scope(&self) -> KeyScope

Where the keys go that no picker, question or global binding takes: the input, the transcript while the person reads it (KeyScope::Transcript, whose keys the input’s back), or the panel with the KeyFocus.

pub fn editor(&self) -> Option<Entity>

The Editor the keys type into: the one of the panel with the KeyFocus, else the MainEditor; None without either.

pub fn completion(&self) -> Option<&Completion>

The open completion, which Up, Down, Tab, Enter and Esc act on.

pub fn typed(&self) -> Option<(CompletionKind, &str)>

The token at the cursor that completion completes, and what is typed of it after its marker, also while nothing matches: for a CompletionSource that looks its candidates up, such as issues matching #14.

pub fn answering(&self) -> Option<Entity>

The question answered in the input: Enter answers it, Esc refuses it.

pub fn picking(&self) -> Option<Entity>

The picker or question shown over the transcript, which takes every key.

pub fn selection(&self) -> Option<usize>

The item highlighted in the picker or question shown over the transcript (picking), as an index into all of its items, whatever typing filtered out; None while none is, such as when the typed answer is.

Trait Implementations

impl Clone for InputContext

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for InputContext

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Debug for InputContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InputContext

fn default() -> Self

Returns the “default value” for a type.

impl Eq for InputContext

impl PartialEq for InputContext

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Resource for InputContext

where Self: Send + Sync + 'static,

impl StructuralPartialEq for InputContext