Struct Anchored 

pub struct Anchored { /* private fields */ }

An element that places its children at an anchor point, and keeps them inside the window.

Create one with anchored. Its children keep their own layout, and the anchored element moves the group so that it sits at the anchor position. It suits popovers, menus and tooltips.

Implementations

impl Anchored

pub fn anchor(self, value: Anchor) -> Self

Sets which corner of the element sits at the anchor position. The default is the top left.

pub fn position(self, value: Point<Pixels>) -> Self

Sets the anchor position. Its meaning depends on Anchored::position_mode: window coordinates by default, or an offset from the parent’s origin for AnchoredPositionMode::Local.

Without this, the anchor is the element’s own position.

pub fn position_mode(self, value: AnchoredPositionMode) -> Self

Sets how Anchored::position is interpreted. The default is AnchoredPositionMode::Window.

AnchoredPositionMode::Window treats the position as window coordinates. AnchoredPositionMode::Local treats it as relative to the element’s parent.

pub fn offset(self, value: Point<Pixels>) -> Self

Moves the placed element by offset, after the anchor position is applied.

Use it to sit beside an anchor rather than on it, such as a popover that’s offset from the button that opens it.

impl Anchored

pub fn snap_to_window(self) -> Self

Snaps the element to the window’s edge when it would overflow, rather than switching corners.

pub fn snap_to_window_with_margin(self, edges: impl Into<Edges<Pixels>>) -> Self

Snaps the element inside the window’s edges, keeping edges as margin from each edge.

The margin is added to the window’s client inset, when the platform sets one.

Trait Implementations

impl Element for Anchored

type RequestLayoutState = AnchoredState

The state that Element::request_layout returns for the later phases.

type PrepaintState = ()

The state that Element::prepaint returns for Element::paint.

fn id(&self) -> Option<ElementId>

Returns the element’s identity, or None if it has none.

fn source_location(&self) -> Option<&'static Location<'static>>

Returns where this element was created, for the inspector and debug output.

fn request_layout( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, window: &mut Window, cx: &mut App, ) -> (LayoutId, Self::RequestLayoutState)

Requests a layout node from Taffy, and returns it with the state the later phases need.

fn prepaint( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, bounds: Bounds<Pixels>, request_layout: &mut Self::RequestLayoutState, window: &mut Window, cx: &mut App, )

Runs once the element’s bounds are known, and returns the state that paint needs.

fn paint( &mut self, _id: Option<&GlobalElementId>, _inspector_id: Option<&InspectorElementId>, _bounds: Bounds<Pixels>, _request_layout: &mut Self::RequestLayoutState, _prepaint: &mut Self::PrepaintState, window: &mut Window, cx: &mut App, )

Draws the element. Runs after prepaint, once per frame.

fn a11y_role(&self) -> Option<Role>

Returns the accessible role for this element, if any. Elements that return None have no accessibility node unless Element::is_a11y_hidden returns true.

fn is_a11y_hidden(&self) -> bool

Whether assistive technology should ignore this element and its descendants.

fn write_a11y_info(&self, _node: &mut Node)

Write accessibility properties to the given node. GPUI calls this only when Element::a11y_role returns Some or Element::is_a11y_hidden returns true.

fn a11y_synthetic_children( &mut self, _prepaint: &mut Self::PrepaintState, _builder: &mut A11ySubtreeBuilder<'_>, )

Add synthetic child nodes to an Element. The element must have an .id(). It must also have a .role() or return true from Element::is_a11y_hidden.

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl IntoElement for Anchored

type Element = Anchored

The element type that this type converts into.

fn into_element(self) -> Self::Element

Converts self into an Element.

fn into_any_element(self) -> AnyElement

Converts self into an AnyElement, with its concrete type erased.

impl ParentElement for Anchored

fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>)

Adds the given children to the end of this element’s children.

fn child(self, child: impl IntoElement) -> Self

where Self: Sized,

Adds one child to this element, and returns the element for chaining.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

where Self: Sized,

Adds several children to this element, in iteration order, and returns the element.