Enum WindowIcon

pub enum WindowIcon {
    Default,
    Image(ImageSource),
}

Window icon.

Variants

Default

The operating system’s default icon.

Image(ImageSource)

Image is requested from IMAGES.

Implementations

impl WindowIcon

pub fn render<I, F>(new_icon: F) -> WindowIcon

where I: UiNode, F: Fn() -> I + Send + Sync + 'static,

New window icon from a closure that generates a new icon UiNode for the window.

The closure is called once on init and every time the window icon property changes, the closure runs in a headless window context, it must return a node to be rendered as an icon.

The icon node is deinited and dropped after the first render, you can enable image::render_retain on it to cause the icon to continue rendering on updates.

Examples

WindowIcon::render(
    || Container! {
        // image::render_retain = true;
        size = (36, 36);
        background_gradient = Line::to_bottom_right(), stops![colors::MIDNIGHT_BLUE, 70.pct(), colors::CRIMSON];
        corner_radius = 6;
        font_size = 28;
        font_weight = FontWeight::BOLD;
        child = Text!("A");
    }
)

Trait Implementations

impl Clone for WindowIcon

fn clone(&self) -> WindowIcon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowIcon

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

Formats the value using the given formatter.

impl Default for WindowIcon

fn default() -> WindowIcon

WindowIcon::Default

impl From<&'static [u8]> for WindowIcon

fn from(data: &'static [u8]) -> WindowIcon

From encoded data of Unknown format.

impl<const N: usize> From<&'static [u8; N]> for WindowIcon

fn from(data: &'static [u8; N]) -> WindowIcon

From encoded data of Unknown format.

impl From<&Path> for WindowIcon

fn from(path: &Path) -> WindowIcon

Converts to this type from the input type.

impl From<&str> for WindowIcon

fn from(s: &str) -> WindowIcon

See ImageSource conversion from &str

impl<F> From<(&'static [u8], F)> for WindowIcon

where F: Into<ImageDataFormat>,

fn from(_: (&'static [u8], F)) -> WindowIcon

From encoded data of known format.

impl<F, const N: usize> From<(&'static [u8; N], F)> for WindowIcon

where F: Into<ImageDataFormat>,

fn from(_: (&'static [u8; N], F)) -> WindowIcon

From encoded data of known format.

impl<F> From<(Arc<Vec<u8>>, F)> for WindowIcon

where F: Into<ImageDataFormat>,

fn from(_: (Arc<Vec<u8>>, F)) -> WindowIcon

From encoded data of known format.

impl<F> From<(Vec<u8>, F)> for WindowIcon

where F: Into<ImageDataFormat>,

fn from(_: (Vec<u8>, F)) -> WindowIcon

From encoded data of known format.

impl From<Arc<Vec<u8>>> for WindowIcon

fn from(data: Arc<Vec<u8>>) -> WindowIcon

From encoded data of Unknown format.

impl From<ImageSource> for WindowIcon

fn from(source: ImageSource) -> WindowIcon

Converts to this type from the input type.

impl From<PathBuf> for WindowIcon

fn from(path: PathBuf) -> WindowIcon

Converts to this type from the input type.

impl From<ReadOnlyVar<Img, ArcVar<Img>>> for WindowIcon

fn from(image: ReadOnlyVar<Img, ArcVar<Img>>) -> WindowIcon

Converts to this type from the input type.

impl From<String> for WindowIcon

fn from(s: String) -> WindowIcon

Same as conversion from &str.

impl From<Txt> for WindowIcon

fn from(s: Txt) -> WindowIcon

Same as conversion from &str.

impl From<Uri> for WindowIcon

fn from(uri: Uri) -> WindowIcon

Converts to this type from the input type.

impl From<Vec<u8>> for WindowIcon

fn from(data: Vec<u8>) -> WindowIcon

From encoded data of Unknown format.

impl IntoVar<WindowIcon> for &'static [u8]

fn into_var(self) -> <&'static [u8] as IntoVar<WindowIcon>>::Var

From encoded data of Unknown format.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<const N: usize> IntoVar<WindowIcon> for &'static [u8; N]

fn into_var(self) -> <&'static [u8; N] as IntoVar<WindowIcon>>::Var

From encoded data of Unknown format.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for &Path

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_var(self) -> <&Path as IntoVar<WindowIcon>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for &str

fn into_var(self) -> <&str as IntoVar<WindowIcon>>::Var

See ImageSource conversion from &str

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<F> IntoVar<WindowIcon> for (&'static [u8], F)

where F: Into<ImageDataFormat>,

fn into_var(self) -> <(&'static [u8], F) as IntoVar<WindowIcon>>::Var

From encoded data of known format.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<F, const N: usize> IntoVar<WindowIcon> for (&'static [u8; N], F)

where F: Into<ImageDataFormat>,

fn into_var(self) -> <(&'static [u8; N], F) as IntoVar<WindowIcon>>::Var

From encoded data of known format.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<F> IntoVar<WindowIcon> for (Arc<Vec<u8>>, F)

where F: Into<ImageDataFormat>,

fn into_var(self) -> <(Arc<Vec<u8>>, F) as IntoVar<WindowIcon>>::Var

From encoded data of known format.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<F> IntoVar<WindowIcon> for (Vec<u8>, F)

where F: Into<ImageDataFormat>,

fn into_var(self) -> <(Vec<u8>, F) as IntoVar<WindowIcon>>::Var

From encoded data of known format.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for Arc<Vec<u8>>

fn into_var(self) -> <Arc<Vec<u8>> as IntoVar<WindowIcon>>::Var

From encoded data of Unknown format.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for ImageSource

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_var(self) -> <ImageSource as IntoVar<WindowIcon>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for PathBuf

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_var(self) -> <PathBuf as IntoVar<WindowIcon>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for ReadOnlyVar<Img, ArcVar<Img>>

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_var(self) -> <ReadOnlyVar<Img, ArcVar<Img>> as IntoVar<WindowIcon>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for String

fn into_var(self) -> <String as IntoVar<WindowIcon>>::Var

Same as conversion from &str.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for Txt

fn into_var(self) -> <Txt as IntoVar<WindowIcon>>::Var

Same as conversion from &str.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for Uri

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_var(self) -> <Uri as IntoVar<WindowIcon>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WindowIcon> for Vec<u8>

fn into_var(self) -> <Vec<u8> as IntoVar<WindowIcon>>::Var

From encoded data of Unknown format.

type Var = LocalVar<WindowIcon>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for WindowIcon

fn eq(&self, other: &WindowIcon) -> 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 IntoValue<WindowIcon> for &'static [u8]

impl<const N: usize> IntoValue<WindowIcon> for &'static [u8; N]

impl IntoValue<WindowIcon> for &Path

impl IntoValue<WindowIcon> for &str

impl<F> IntoValue<WindowIcon> for (&'static [u8], F)

where F: Into<ImageDataFormat>,

impl<F, const N: usize> IntoValue<WindowIcon> for (&'static [u8; N], F)

where F: Into<ImageDataFormat>,

impl<F> IntoValue<WindowIcon> for (Arc<Vec<u8>>, F)

where F: Into<ImageDataFormat>,

impl<F> IntoValue<WindowIcon> for (Vec<u8>, F)

where F: Into<ImageDataFormat>,

impl IntoValue<WindowIcon> for Arc<Vec<u8>>

impl IntoValue<WindowIcon> for ImageSource

impl IntoValue<WindowIcon> for PathBuf

impl IntoValue<WindowIcon> for ReadOnlyVar<Img, ArcVar<Img>>

impl IntoValue<WindowIcon> for String

impl IntoValue<WindowIcon> for Txt

impl IntoValue<WindowIcon> for Uri

impl IntoValue<WindowIcon> for Vec<u8>

impl StructuralPartialEq for WindowIcon