Struct Pod

pub struct Pod<V> { /* private fields */ }

A view that has separate ViewState from its content.

When calling for example View::event, an EventCx is passed to the function. This EventCx contains a mutable reference to a ViewState that is used to keep track of state like whether the view is hovered or active. If a pod is not used when implementing a view, the View and the content share the same ViewState. This is almost always an issue when the View wants to have a diffrent transform or size than the content. See for example the Pad view.

Examples

use ori::prelude::*;

struct ContainerView<V> {
    // We wrap the content in a Pod here
    content: Pod<V>,
}

impl<V: View<T>, T> View<T> for ContainerView<V> {
    // We use the Pod's state here
    type State = State<T, V>;

    fn build(&mut self, cx: &mut BuildCx, data: &mut T) -> Self::State {
        self.content.build(cx, data)
    }

    // ...
}

Implementations

impl<V> Pod<V>

pub const fn new(view: V) -> Pod<V>

Create a new pod view.

pub fn event_maybe<T>( &mut self, handled: bool, state: &mut PodState<T, V>, cx: &mut EventCx<'_, '_>, data: &mut T, event: &Event, ) -> bool

where V: View<T>,

Call the View::event method on the content, only if the event hasn’t been handled.

Trait Implementations

impl<V> Clone for Pod<V>

where V: Clone,

fn clone(&self) -> Pod<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Debug for Pod<V>

where V: Debug,

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

Formats the value using the given formatter.

impl<V> Deref for Pod<V>

type Target = V

The resulting type after dereferencing.

fn deref(&self) -> &<Pod<V> as Deref>::Target

Dereferences the value.

impl<V> DerefMut for Pod<V>

fn deref_mut(&mut self) -> &mut <Pod<V> as Deref>::Target

Mutably dereferences the value.

impl<V> From<V> for Pod<V>

fn from(view: V) -> Pod<V>

Converts to this type from the input type.

impl<V> Hash for Pod<V>

where V: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<V> PartialEq for Pod<V>

where V: PartialEq,

fn eq(&self, other: &Pod<V>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, V> View<T> for Pod<V>

where V: View<T>,

type State = PodState<T, V>

The state of the view, see top-level documentation for more information.

fn build( &mut self, cx: &mut BuildCx<'_, '_>, data: &mut T, ) -> <Pod<V> as View<T>>::State

Build the view state, see top-level documentation for more information.

fn rebuild( &mut self, state: &mut <Pod<V> as View<T>>::State, cx: &mut RebuildCx<'_, '_>, data: &mut T, old: &Pod<V>, )

Rebuild the view state, see top-level documentation for more information.

fn event( &mut self, state: &mut <Pod<V> as View<T>>::State, cx: &mut EventCx<'_, '_>, data: &mut T, event: &Event, ) -> bool

Handle an event, see top-level documentation for more information.

fn layout( &mut self, state: &mut <Pod<V> as View<T>>::State, cx: &mut LayoutCx<'_, '_>, data: &mut T, space: Space, ) -> Size

Layout the view, see top-level documentation for more information.

fn draw( &mut self, state: &mut <Pod<V> as View<T>>::State, cx: &mut DrawCx<'_, '_>, data: &mut T, )

Draw the view, see top-level documentation for more information.

impl<V> Copy for Pod<V>

where V: Copy,

impl<V> Eq for Pod<V>

where V: Eq,

impl<V> StructuralPartialEq for Pod<V>