AnnotationRegistry

Struct AnnotationRegistry 

Source
pub struct AnnotationRegistry { /* private fields */ }
Expand description

Registry that collects widget annotations during rendering.

The registry maintains a tree structure of annotated regions, enabling queries like “what widget is at position X,Y” or “find all buttons”.

Implementations§

Source§

impl AnnotationRegistry

Source

pub fn new() -> Self

Creates a new empty registry.

Source

pub fn clear(&mut self)

Clears all registered annotations.

Source

pub fn register(&mut self, area: Rect, annotation: Annotation) -> usize

Registers a new annotated region.

Returns the index of the registered region.

Source

pub fn open(&mut self, area: Rect, annotation: Annotation) -> usize

Opens a region (for nested widgets).

Subsequent registrations will be children of this region.

Source

pub fn close(&mut self)

Closes the current region.

Source

pub fn len(&self) -> usize

Returns the number of registered regions.

Source

pub fn is_empty(&self) -> bool

Returns true if no regions are registered.

Source

pub fn regions(&self) -> &[RegionInfo]

Returns all registered regions.

Source

pub fn get(&self, index: usize) -> Option<&RegionInfo>

Returns a region by index.

Source

pub fn region_at(&self, x: u16, y: u16) -> Option<&RegionInfo>

Returns the region at the given position.

If multiple regions overlap, returns the deepest one (most specific).

Source

pub fn regions_at(&self, x: u16, y: u16) -> Vec<&RegionInfo>

Returns all regions at the given position.

Source

pub fn find_by_id(&self, id: &str) -> Vec<&RegionInfo>

Finds regions by annotation id.

Source

pub fn get_by_id(&self, id: &str) -> Option<&RegionInfo>

Finds the first region with the given id.

Source

pub fn find_by_type(&self, widget_type: &WidgetType) -> Vec<&RegionInfo>

Finds regions by widget type.

Source

pub fn interactive_regions(&self) -> Vec<&RegionInfo>

Returns all interactive regions.

Source

pub fn focused_region(&self) -> Option<&RegionInfo>

Returns the currently focused region, if any.

Source

pub fn root_regions(&self) -> Vec<&RegionInfo>

Returns root regions (depth 0).

Source

pub fn children_of(&self, index: usize) -> Vec<&RegionInfo>

Returns children of a region.

Source

pub fn format_tree(&self) -> String

Formats the registry as a tree for debugging.

Trait Implementations§

Source§

impl Clone for AnnotationRegistry

Source§

fn clone(&self) -> AnnotationRegistry

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnnotationRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AnnotationRegistry

Source§

fn default() -> AnnotationRegistry

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AnnotationRegistry

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AnnotationRegistry

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,