Enum WindowIcon 

#[non_exhaustive]
pub enum WindowIcon {
    Default,
    Image(ImageSource),
}

Window icon.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

The operating system’s default icon.

Image(ImageSource)

Image is requested from IMAGES.

Implementations

impl WindowIcon

pub fn render(new_icon: impl Fn() -> UiNode + Send + Sync + 'static) -> Self

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

Formats the value using the given formatter.

impl Default for WindowIcon

fn default() -> Self

WindowIcon::Default

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

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

From encoded data of Unknown format.

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

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

From encoded data of Unknown format.

impl From<&Path> for WindowIcon

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<&str> for WindowIcon

fn from(s: &str) -> Self

See ImageSource conversion from &str

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

fn from((data, format): (&'static [u8], F)) -> Self

From encoded data of known format.

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

fn from((data, format): (&'static [u8; N], F)) -> Self

From encoded data of known format.

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

fn from((data, format): (Arc<Vec<u8>>, F)) -> Self

From encoded data of known format.

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

fn from((data, format): (Vec<u8>, F)) -> Self

From encoded data of known format.

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

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

From encoded data of Unknown format.

impl From<ImageSource> for WindowIcon

fn from(source: ImageSource) -> Self

Converts to this type from the input type.

impl From<PathBuf> for WindowIcon

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl From<String> for WindowIcon

fn from(s: String) -> Self

Same as conversion from &str.

impl From<Txt> for WindowIcon

fn from(s: Txt) -> Self

Same as conversion from &str.

impl From<Uri> for WindowIcon

fn from(uri: Uri) -> Self

Converts to this type from the input type.

impl From<Var<Img>> for WindowIcon

fn from(image: ImageVar) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for WindowIcon

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

From encoded data of Unknown format.

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

fn into_var(self) -> Var<WindowIcon>

From encoded data of Unknown format.

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

fn into_var(self) -> Var<WindowIcon>

From encoded data of Unknown format.

impl IntoVar<WindowIcon> for &Path

fn into_var(self) -> Var<WindowIcon>

impl IntoVar<WindowIcon> for &str

fn into_var(self) -> Var<WindowIcon>

See ImageSource conversion from &str

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

fn into_var(self) -> Var<WindowIcon>

From encoded data of known format.

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

fn into_var(self) -> Var<WindowIcon>

From encoded data of known format.

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

fn into_var(self) -> Var<WindowIcon>

From encoded data of known format.

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

fn into_var(self) -> Var<WindowIcon>

From encoded data of known format.

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

fn into_var(self) -> Var<WindowIcon>

From encoded data of Unknown format.

impl IntoVar<WindowIcon> for ImageSource

fn into_var(self) -> Var<WindowIcon>

impl IntoVar<WindowIcon> for PathBuf

fn into_var(self) -> Var<WindowIcon>

impl IntoVar<WindowIcon> for String

fn into_var(self) -> Var<WindowIcon>

Same as conversion from &str.

impl IntoVar<WindowIcon> for Txt

fn into_var(self) -> Var<WindowIcon>

Same as conversion from &str.

impl IntoVar<WindowIcon> for Uri

fn into_var(self) -> Var<WindowIcon>

impl IntoVar<WindowIcon> for ImageVar

fn into_var(self) -> Var<WindowIcon>

impl IntoVar<WindowIcon> for Vec<u8>

fn into_var(self) -> Var<WindowIcon>

From encoded data of Unknown format.

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: Into<ImageDataFormat>> IntoValue<WindowIcon> for (&'static [u8], F)

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

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

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

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

impl IntoValue<WindowIcon> for ImageSource

impl IntoValue<WindowIcon> for PathBuf

impl IntoValue<WindowIcon> for String

impl IntoValue<WindowIcon> for Txt

impl IntoValue<WindowIcon> for Uri

impl IntoValue<WindowIcon> for ImageVar

impl IntoValue<WindowIcon> for Vec<u8>

impl StructuralPartialEq for WindowIcon