Struct vizia::context::Context

source ·
pub struct Context {
    pub ignore_default_theme: bool,
    pub window_has_focus: bool,
    /* private fields */
}
Expand description

The main storage and control object for a Vizia application.

Fields§

§ignore_default_theme: bool§window_has_focus: bool

Implementations§

source§

impl Context

source

pub fn new(window_size: WindowSize, user_scale_factor: f64) -> Context

Creates a new context.

source

pub fn current(&self) -> Entity

The “current” entity, generally the entity which is currently being built or the entity which is currently having an event dispatched to it.

source

pub fn with_current<T>( &mut self, e: Entity, f: impl FnOnce(&mut Context) -> T ) -> T

Makes the above black magic more explicit

source

pub fn environment(&self) -> &Environment

Returns a reference to the Environment model.

source

pub fn window_size(&self) -> WindowSize

The window’s size in logical pixels, before user_scale_factor() gets applied to it. If this value changed during a frame then the window will be resized and a WindowEvent::GeometryChanged will be emitted.

source

pub fn user_scale_factor(&self) -> f64

A scale factor used for uniformly scaling the window independently of any HiDPI scaling. window_size gets multplied with this factor to get the actual logical window size. If this changes during a frame, then the window will be resized at the end of the frame and a WindowEvent::GeometryChanged will be emitted. This can be initialized using WindowDescription::user_scale_factor.

source

pub fn scale_factor(&self) -> f32

Returns the scale factor of the display.

source

pub fn needs_redraw(&mut self)

Mark the application as needing to rerun the draw method

source

pub fn needs_restyle(&mut self, entity: Entity)

Mark the application as needing to recompute view styles

source

pub fn needs_relayout(&mut self)

Mark the application as needing to rerun layout computations

source

pub fn focus_with_visibility(&mut self, focus_visible: bool)

Sets application focus to the current entity with the specified focus visiblity

source

pub fn focus(&mut self)

Sets application focus to the current entity using the previous focus visibility

source

pub fn add_listener<F, W>(&mut self, listener: F)
where W: View, F: 'static + Fn(&mut W, &mut EventContext<'_>, &mut Event),

Add a listener to an entity.

A listener can be used to handle events which would not normally propagate to the entity. For example, mouse events when a different entity has captured them. Useful for things like closing a popup when clicking outside of its bounding box.

source

pub fn add_global_listener<F>(&mut self, listener: F)
where F: 'static + Fn(&mut EventContext<'_>, &mut Event),

Adds a global listener to the application.

Global listeners have the first opportunity to handle every event that is sent in an application. They will never be removed. If you need a listener tied to the lifetime of a view, use add_listener.

source

pub fn set_language(&mut self, lang: LanguageIdentifier)

Sets the language used by the application for localization.

source

pub fn add_font_mem(&mut self, data: impl AsRef<[u8]>)

source

pub fn set_default_font(&mut self, names: &[&str])

Sets the global default font for the application.

source

pub fn add_stylesheet(&mut self, style: impl IntoCssStr) -> Result<(), Error>

source

pub fn remove_user_themes(&mut self)

Remove all user themes from the application.

source

pub fn add_animation(&mut self, animation: AnimationBuilder<'_>) -> Animation

source

pub fn set_image_loader<F>(&mut self, loader: F)
where F: 'static + Fn(&mut ResourceContext<'_>, &str),

source

pub fn add_translation(&mut self, lang: LanguageIdentifier, ftl: impl ToString)

source

pub fn add_timer( &mut self, interval: Duration, duration: Option<Duration>, callback: impl Fn(&mut EventContext<'_>, TimerAction) + 'static ) -> Timer

Adds a timer to the application.

interval - The time between ticks of the timer. duration - An optional duration for the timer. Pass None for a continuos timer. callback - A callback which is called on when the timer is started, ticks, and stops. Disambiguated by the TimerAction parameter of the callback.

Returns a Timer id which can be used to start and stop the timer.

§Example

Creates a timer which calls the provided callback every second for 5 seconds:

let timer = cx.add_timer(Duration::from_secs(1), Some(Duration::from_secs(5)), |cx, reason|{
    match reason {
        TimerAction::Start => {
            println!("Start timer");
        }
     
        TimerAction::Tick(delta) => {
            println!("Tick timer: {:?}", delta);
        }

        TimerAction::Stop => {
            println!("Stop timer");
        }
    }
});
source

pub fn start_timer(&mut self, timer: Timer)

Starts a timer with the provided timer id.

Events sent within the timer callback provided in add_timer() will target the current view.

source

pub fn modify_timer( &mut self, timer: Timer, timer_function: impl Fn(&mut TimerState) )

Modifies the state of an existing timer with the provided Timer id.

source

pub fn timer_is_running(&mut self, timer: Timer) -> bool

Returns true if the timer with the provided timer id is currently running.

source

pub fn stop_timer(&mut self, timer: Timer)

Stops the timer with the given timer id.

Any events emitted in response to the timer stopping, as determined by the callback provided in add_timer(), will target the view which called start_timer().

source

pub fn load_image( &mut self, path: &str, image: DynamicImage, policy: ImageRetentionPolicy )

source

pub fn spawn<F>(&self, target: F)
where F: 'static + Send + FnOnce(&mut ContextProxy),

source

pub fn get_proxy(&self) -> ContextProxy

source

pub fn resolve_entity_identifier(&self, identity: &str) -> Option<Entity>

Finds the entity that identifier identifies

source

pub fn toggle_class(&mut self, class_name: &str, applied: bool)

Toggles the addition/removal of a class name for the current view.

§Example
cx.toggle_class("foo", true);

Trait Implementations§

source§

impl<'a, V> AsMut<Context> for Handle<'a, V>

source§

fn as_mut(&mut self) -> &mut Context

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl DataContext for Context

source§

fn data<T>(&self) -> Option<&T>
where T: 'static,

Get model/view data from the context. Returns None if the data does not exist.
source§

fn as_context(&self) -> Option<LocalizationContext<'_>>

source§

impl Default for Context

source§

fn default() -> Context

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

impl EmitContext for Context

source§

fn emit<M>(&mut self, message: M)
where M: Any + Send,

Send an event containing the provided message up the tree from the current entity. Read more
source§

fn emit_to<M>(&mut self, target: Entity, message: M)
where M: Any + Send,

Send an event containing the provided message directly to a specified entity from the current entity. Read more
source§

fn emit_custom(&mut self, event: Event)

Send a custom event with custom origin and propagation information. Read more
source§

fn schedule_emit<M>(&mut self, message: M, at: Instant) -> TimedEventHandle
where M: Any + Send,

Send an event containing the provided message up the tree at a particular time instant. Read more
source§

fn schedule_emit_to<M>( &mut self, target: Entity, message: M, at: Instant ) -> TimedEventHandle
where M: Any + Send,

Send an event containing the provided message directly to a specified view at a particular time instant. Read more
source§

fn schedule_emit_custom( &mut self, event: Event, at: Instant ) -> TimedEventHandle

Send a custom event with custom origin and propagation information at a particular time instant. Read more
source§

fn cancel_scheduled(&mut self, handle: TimedEventHandle)

Cancel a scheduled event before it is sent. Read more
source§

impl GetRawWindowHandle for Context

source§

fn raw_window_handle(&mut self) -> RawWindowHandle

source§

fn mutate_window<T>(&mut self, f: impl FnOnce(&Window) -> T) -> Option<T>

Auto Trait Implementations§

§

impl Freeze for Context

§

impl !RefUnwindSafe for Context

§

impl !Send for Context

§

impl !Sync for Context

§

impl Unpin for Context

§

impl !UnwindSafe for Context

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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<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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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