Struct Icon

pub struct Icon {
    pub handle: HANDLE,
    /* private fields */
}

A wrapper over a icon file (*.ico)

Windows icons are a legacy thing and should only be used when winapi forces you to use them (ex: when setting a window icon). The Bitmap object of NWG not only supports transparency if “image-decoder” is enabled but it can also be create from multiple different sources (including “.ico” files).

To display a icon in an application, see the ImageFrame control.

Note: Loading an icon from binary source (source_bin) REQUIRES the “image-decoder” feature.

Builder parameters:

• source_file: The source of the icon if it is a file.
• source_bin: The source of the icon if it is a binary blob. For example using include_bytes!("my_icon.ico").
• source_system: The source of the icon if it is a system resource (see OemIcon)
• source_embed: The source of the icon if it is stored in an embedded file
• source_embed_id: The number identifier of the icon in the embedded file
• source_embed_str: The string identifier of the icon in the embedded file
• size: Optional. Resize the image to this size.
• strict: Use a system placeholder instead of panicking if the image source do no exists.

Example:

use native_windows_gui as nwg;

fn load_icon() -> nwg::Icon {
    nwg::Icon::from_file("hello.ico", true).unwrap()
}

fn load_icon_builder() -> nwg::Icon {
    let mut icon = nwg::Icon::default();

    nwg::Icon::builder()
        .source_file(Some("hello.ico"))
        .strict(true)
        .build(&mut icon);

    icon
}

Fields

handle: HANDLE

Implementations

impl Icon

pub fn builder<'a>() -> IconBuilder<'a>

Examples found in repository

examples/system_tray.rs (line 64)

        fn build_ui(mut data: SystemTray) -> Result<SystemTrayUi, nwg::NwgError> {
            use nwg::Event as E;

            // Resources
            nwg::Icon::builder()
                .source_file(Some("./test_rc/cog.ico"))
                .build(&mut data.icon)?;
            
            // Controls
            nwg::MessageWindow::builder()
                .build(&mut data.window)?;

            nwg::TrayNotification::builder()
                .parent(&data.window)
                .icon(Some(&data.icon))
                .tip(Some("Hello"))
                .build(&mut data.tray)?;

            nwg::Menu::builder()
                .popup(true)
                .parent(&data.window)
                .build(&mut data.tray_menu)?;

            nwg::MenuItem::builder()
                .text("Hello")
                .parent(&data.tray_menu)
                .build(&mut data.tray_item1)?;

            nwg::MenuItem::builder()
                .text("Popup")
                .parent(&data.tray_menu)
                .build(&mut data.tray_item2)?;

            nwg::MenuItem::builder()
                .text("Exit")
                .parent(&data.tray_menu)
                .build(&mut data.tray_item3)?;

            // Wrap-up
            let ui = SystemTrayUi {
                inner: Rc::new(data),
                default_handler: Default::default(),
            };

            // Events
            let evt_ui = Rc::downgrade(&ui.inner);
            let handle_events = move |evt, _evt_data, handle| {
                if let Some(evt_ui) = evt_ui.upgrade() {
                    match evt {
                        E::OnContextMenu => 
                            if &handle == &evt_ui.tray {
                                SystemTray::show_menu(&evt_ui);
                            }
                        E::OnMenuItemSelected => 
                            if &handle == &evt_ui.tray_item1 {
                                SystemTray::hello1(&evt_ui);
                            } else if &handle == &evt_ui.tray_item2 {
                                SystemTray::hello2(&evt_ui);
                            } else if &handle == &evt_ui.tray_item3 {
                                SystemTray::exit(&evt_ui);
                            },
                        _ => {}
                    }
                }
            };

            ui.default_handler.borrow_mut().push(
                nwg::full_bind_event_handler(&ui.window.handle, handle_events)
            );

            return Ok(ui);
        }

pub fn from_system(sys_icon: OemIcon) -> Icon

Single line helper function over the icon builder api.

Use system resources.

pub fn from_file(path: &str, strict: bool) -> Result<Icon, NwgError>

Single line helper function over the icon builder api.

Use a file resource.

pub fn from_bin(bin: &[u8]) -> Result<Icon, NwgError>

Single line helper function over the icon builder api.

Use a binary resource.

pub fn from_embed( embed: &EmbedResource, embed_id: Option<usize>, embed_str: Option<&str>, ) -> Result<Icon, NwgError>

Single line helper function over the icon builder api.

Use an embedded resource. Either embed_id or embed_str must be defined, not both.

Requires the embed-resource feature.

Trait Implementations

impl Default for Icon

fn default() -> Icon

Returns the “default value” for a type.

impl Drop for Icon

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Icon

fn eq(&self, other: &Self) -> 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.