Struct gooey::widgets::component::Component

source · [−]

pub struct Component<B> where
    B: Behavior,  {
    pub behavior: B,
    /* private fields */
}

Fields

behavior: B

Implementations

source

pub fn register_widget(
 &mut self,
 id: ::Widgets,
 registration: &WidgetRegistration
)

source

pub fn remove(&mut self, id: &::Widgets)

source

pub fn map_content<F, R>(
 &self,
 context: &Context<Component>,
 with_fn: F
) -> Option<R> where
 F: FnOnce(&::Content, &Context<::Content>) -> R,

source

pub fn map_content_mut<F, R>(
 &self,
 context: &Context<Component>,
 with_fn: F
) -> Option<R> where
 F: FnOnce(&mut ::Content, &Context<::Content>) -> R,

source

pub fn map_widget<OW, F, R>(
 &self,
 id: &::Widgets,
 context: &Context<Component>,
 with_fn: F
) -> Option<R> where
 OW: Widget,
 F: FnOnce(&OW, &Context<OW>) -> R,

source

pub fn map_widget_mut<OW, F, R>(
 &self,
 id: &::Widgets,
 context: &Context<Component>,
 with_fn: F
) -> Option<R> where
 OW: Widget,
 F: FnOnce(&mut OW, &Context<OW>) -> R,

source

pub fn widget_state(
 &self,
 id: &::Widgets,
 context: &Context<Component>
) -> Option<WidgetState>

source

pub fn lock_widget<W>(
 &self,
 id: &::Widgets,
 context: &Context<Component>
) -> Option<LockedWidget<W>> where
 W: Widget,

source

pub fn map_event<I, C>(&self, mapper: C) -> Callback<I, ()> where
I: 'static,
C: 'static + CallbackFn<I, ::Event>,

source

pub fn event_mapper(&self) -> EventMapper

Trait Implementations

source

impl Debug for Component where
 B: Debug + Behavior,
 ::Content: Debug,
 ::Widgets: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl DefaultWidget for Component where
B: Behavior + Default,

source

fn default_for(storage: &WidgetStorage) -> StyledWidget<Component>

Returns a default widget.

source

impl Deref for Component where
B: Behavior,

type Target = B

The resulting type after dereferencing.

source

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

Dereferences the value.

source

impl DerefMut for Component where
B: Behavior,

source

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

Mutably dereferences the value.

source

impl<Loc> NavigatorBar for Component<DefaultBarBehavior<Loc>> where
Loc: Location,

source

fn new(
navigator: WeakWidgetRegistration,
storage: &WidgetStorage
) -> StyledWidget<Component<DefaultBarBehavior<Loc>>>

source

fn set_back_button(
 &mut self,
 label: Option<&str>,
 context: &Context<Component<DefaultBarBehavior<Loc>>>
)

source

fn set_title(
 &mut self,
 title: &str,
 context: &Context<Component<DefaultBarBehavior<Loc>>>
)

type Command = ComponentCommand<<::Content as Widget>::Command, ::Event>

Widgets may need to communicate with transmogrifier implementations. This type is the type that can be sent to a transmogrifier. Read more

type Event = InternalEvent

The type of the event that any Transmogrifier for this widget to use. Read more

source

const CLASS: &'static str = "gooey-component"

The unique class name for this widget. Must not conflict with any other widgets in use. Widget authors should prefix their widget names to ensure no conflicts. For example, the gooey-widgets crate prefixes all of the CLASS constants with gooey-. Read more

source

const FOCUSABLE: bool = false

When true, the control is able to receive focus through focus advancement, most commonly done when using the tab key. Read more

source

fn classes() -> Classes

Returns all classes that apply styles for this widget.

source

fn receive_event(
 &mut self,
 event: <Component as Widget>::Event,
 context: &Context<Component>
)

Called when an event from the transmogrifier was received.

source

fn text_color(style: &Style) -> Option<&ColorPair>

Returns the effective text color for the given style.

source

fn background_color(style: &Style) -> Option<&ColorPair>

Returns the effective background color for the given style.

source

fn map<OW, F, R>(
 widget_id: &WidgetId,
 context: &Context<Self>,
 with_fn: F
) -> Option<R> where
 OW: Widget,
 F: FnOnce(&OW, &Context<OW>) -> R,

Invokes with_fn with the widget widget_id and a Context. Returns the result. Read more

source

fn map_mut<OW, F, R>(
 widget_id: &WidgetId,
 context: &Context<Self>,
 with_fn: F
) -> Option<R> where
 OW: Widget,
 F: FnOnce(&mut OW, &Context<OW>) -> R,

Invokes with_fn with the widget widget_id and a Context. Returns the result. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Component

impl Send for Component

impl Sync for Component

impl Unpin for Component where
B: Unpin,
::Content: Unpin,

impl !UnwindSafe for Component

Blanket Implementations

source

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
 T: FloatComponent,
 Swp: WhitePoint,
 Dwp: WhitePoint,
 D: AdaptFrom<S, Swp, Dwp, T>,

source

fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,

Convert the source color to the destination color using the specified method Read more

source

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default Read more

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> AnySendSync for T where
T: Any + Debug + Send + Sync,

source

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Returns the underlying type as Any.

source

fn as_any(&self) -> &(dyn Any + 'static)

Returns the underlying type as Any.

source

impl<T> AnyWidget for T where
T: Widget + Debug + Send + Sync + Any,

source

fn widget_type_id(&self) -> TypeId

Returns the TypeId of the widget.

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · 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, U> IntoColor for T where
U: FromColor<T>,

source

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

source

impl<T, U> IntoColorUnclamped for T where
U: FromColorUnclamped<T>,

source

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryIntoColor for T where
U: TryFromColor<T>,

source

fn try_into_color(self) -> Result<U, OutOfBounds>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct gooey::widgets::component::Component

Fields

Implementations

impl<B> Component<B> where B: Behavior,

pub fn new(behavior: B, storage: &WidgetStorage) -> StyledWidget<Component<B>>

pub fn content(&self) -> Option<&WidgetRef<<B as Behavior>::Content>>

pub fn registered_widget( &self, id: &<B as Behavior>::Widgets) -> Option<WidgetRegistration>

pub fn register_widget( &mut self, id: <B as Behavior>::Widgets, registration: &WidgetRegistration)

pub fn remove(&mut self, id: &<B as Behavior>::Widgets)

pub fn map_content<F, R>( &self, context: &Context<Component<B>>, with_fn: F) -> Option<R> where F: FnOnce(&<B as Behavior>::Content, &Context<<B as Behavior>::Content>) -> R,

pub fn map_content_mut<F, R>( &self, context: &Context<Component<B>>, with_fn: F) -> Option<R> where F: FnOnce(&mut <B as Behavior>::Content, &Context<<B as Behavior>::Content>) -> R,

pub fn map_widget<OW, F, R>( &self, id: &<B as Behavior>::Widgets, context: &Context<Component<B>>, with_fn: F) -> Option<R> where OW: Widget, F: FnOnce(&OW, &Context<OW>) -> R,

pub fn map_widget_mut<OW, F, R>( &self, id: &<B as Behavior>::Widgets, context: &Context<Component<B>>, with_fn: F) -> Option<R> where OW: Widget, F: FnOnce(&mut OW, &Context<OW>) -> R,

pub fn widget_state( &self, id: &<B as Behavior>::Widgets, context: &Context<Component<B>>) -> Option<WidgetState>

pub fn lock_widget<W>( &self, id: &<B as Behavior>::Widgets, context: &Context<Component<B>>) -> Option<LockedWidget<W>> where W: Widget,

pub fn map_event<I, C>(&self, mapper: C) -> Callback<I, ()> where I: 'static, C: 'static + CallbackFn<I, <B as Behavior>::Event>,

pub fn event_mapper(&self) -> EventMapper<B>

Trait Implementations

impl<B> Debug for Component<B> where B: Debug + Behavior, <B as Behavior>::Content: Debug, <B as Behavior>::Widgets: Debug,

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

impl<B> DefaultWidget for Component<B> where B: Behavior + Default,

fn default_for(storage: &WidgetStorage) -> StyledWidget<Component<B>>

impl<B> Deref for Component<B> where B: Behavior,

type Target = B

fn deref(&self) -> &<Component<B> as Deref>::Target

impl<B> DerefMut for Component<B> where B: Behavior,

fn deref_mut(&mut self) -> &mut <Component<B> as Deref>::Target

impl<Loc> NavigatorBar for Component<DefaultBarBehavior<Loc>> where Loc: Location,

fn new( navigator: WeakWidgetRegistration, storage: &WidgetStorage) -> StyledWidget<Component<DefaultBarBehavior<Loc>>>

fn set_back_button( &mut self, label: Option<&str>, context: &Context<Component<DefaultBarBehavior<Loc>>>)

fn set_title( &mut self, title: &str, context: &Context<Component<DefaultBarBehavior<Loc>>>)

impl<B> Widget for Component<B> where B: Behavior,

type Command = ComponentCommand<<<B as Behavior>::Content as Widget>::Command, <B as Behavior>::Event>

type Event = InternalEvent<B>

const CLASS: &'static str = "gooey-component"

const FOCUSABLE: bool = false

fn classes() -> Classes

fn receive_event( &mut self, event: <Component<B> as Widget>::Event, context: &Context<Component<B>>)

fn text_color(style: &Style) -> Option<&ColorPair>

fn background_color(style: &Style) -> Option<&ColorPair>

fn map<OW, F, R>( widget_id: &WidgetId, context: &Context<Self>, with_fn: F) -> Option<R> where OW: Widget, F: FnOnce(&OW, &Context<OW>) -> R,

fn map_mut<OW, F, R>( widget_id: &WidgetId, context: &Context<Self>, with_fn: F) -> Option<R> where OW: Widget, F: FnOnce(&mut OW, &Context<OW>) -> R,

Auto Trait Implementations

impl<B> !RefUnwindSafe for Component<B>

impl<B> Send for Component<B>

impl<B> Sync for Component<B>

impl<B> Unpin for Component<B> where B: Unpin, <B as Behavior>::Content: Unpin,

impl<B> !UnwindSafe for Component<B>

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where T: FloatComponent, Swp: WhitePoint, Dwp: WhitePoint, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,

fn adapt_into(self) -> D

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

fn type_id(&self) -> TypeId

impl<T> AnySendSync for T where T: Any + Debug + Send + Sync,

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

fn as_any(&self) -> &(dyn Any + 'static)

impl<T> AnyWidget for T where T: Widget + Debug + Send + Sync + Any,

fn widget_type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T, U> IntoColor<U> for T where U: FromColor<T>,

fn into_color(self) -> U

impl<T, U> IntoColorUnclamped<U> for T where U: FromColorUnclamped<T>,

fn into_color_unclamped(self) -> U

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

type Error = Infallible

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

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

impl<B> Component<B> where
B: Behavior,

pub fn registered_widget(
&self,
id: &<B as Behavior>::Widgets
) -> Option<WidgetRegistration>

pub fn register_widget(
&mut self,
id: <B as Behavior>::Widgets,
registration: &WidgetRegistration
)

pub fn map_content<F, R>(
&self,
context: &Context<Component<B>>,
with_fn: F
) -> Option<R> where
F: FnOnce(&<B as Behavior>::Content, &Context<<B as Behavior>::Content>) -> R,

pub fn map_content_mut<F, R>(
&self,
context: &Context<Component<B>>,
with_fn: F
) -> Option<R> where
F: FnOnce(&mut <B as Behavior>::Content, &Context<<B as Behavior>::Content>) -> R,

pub fn map_widget<OW, F, R>(
&self,
id: &<B as Behavior>::Widgets,
context: &Context<Component<B>>,
with_fn: F
) -> Option<R> where
OW: Widget,
F: FnOnce(&OW, &Context<OW>) -> R,

pub fn map_widget_mut<OW, F, R>(
&self,
id: &<B as Behavior>::Widgets,
context: &Context<Component<B>>,
with_fn: F
) -> Option<R> where
OW: Widget,
F: FnOnce(&mut OW, &Context<OW>) -> R,

pub fn widget_state(
&self,
id: &<B as Behavior>::Widgets,
context: &Context<Component<B>>
) -> Option<WidgetState>

pub fn lock_widget<W>(
&self,
id: &<B as Behavior>::Widgets,
context: &Context<Component<B>>
) -> Option<LockedWidget<W>> where
W: Widget,

pub fn map_event<I, C>(&self, mapper: C) -> Callback<I, ()> where
I: 'static,
C: 'static + CallbackFn<I, <B as Behavior>::Event>,

impl<B> Debug for Component<B> where
B: Debug + Behavior,
<B as Behavior>::Content: Debug,
<B as Behavior>::Widgets: Debug,

impl<B> DefaultWidget for Component<B> where
B: Behavior + Default,

impl<B> Deref for Component<B> where
B: Behavior,

impl<B> DerefMut for Component<B> where
B: Behavior,

impl<Loc> NavigatorBar for Component<DefaultBarBehavior<Loc>> where
Loc: Location,

fn new(
navigator: WeakWidgetRegistration,
storage: &WidgetStorage
) -> StyledWidget<Component<DefaultBarBehavior<Loc>>>

fn set_back_button(
&mut self,
label: Option<&str>,
context: &Context<Component<DefaultBarBehavior<Loc>>>
)

fn set_title(
&mut self,
title: &str,
context: &Context<Component<DefaultBarBehavior<Loc>>>
)

impl<B> Widget for Component<B> where
B: Behavior,

fn receive_event(
&mut self,
event: <Component<B> as Widget>::Event,
context: &Context<Component<B>>
)

fn map<OW, F, R>(
widget_id: &WidgetId,
context: &Context<Self>,
with_fn: F
) -> Option<R> where
OW: Widget,
F: FnOnce(&OW, &Context<OW>) -> R,

fn map_mut<OW, F, R>(
widget_id: &WidgetId,
context: &Context<Self>,
with_fn: F
) -> Option<R> where
OW: Widget,
F: FnOnce(&mut OW, &Context<OW>) -> R,

impl<B> Unpin for Component<B> where
B: Unpin,
<B as Behavior>::Content: Unpin,

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
T: FloatComponent,
Swp: WhitePoint,
Dwp: WhitePoint,
D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,

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

impl<T> AnySendSync for T where
T: Any + Debug + Send + Sync,

impl<T> AnyWidget for T where
T: Widget + Debug + Send + Sync + Any,

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

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

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

impl<T, U> IntoColor<U> for T where
U: FromColor<T>,

impl<T, U> IntoColorUnclamped<U> for T where
U: FromColorUnclamped<T>,

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

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

impl<T, U> TryIntoColor<U> for T where
U: TryFromColor<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,