Struct native_windows_gui::ImageFrame

pub struct ImageFrame {
    pub handle: ControlHandle,
    /* private fields */
}

An image frame is a control that displays a Bitmap or a Icon image resource.

ImageFrame is not behind any features.

Builder parameters:

• parent: Required. The image frame parent container.
• size: The image frame size.
• position: The image frame position.
• flags: A combination of the ImageFrameFlags values.
• ex_flags: A combination of win32 window extended flags. Unlike flags, ex_flags must be used straight from winapi
• background_color: The background color of the image frame. Used if the image is smaller than the control
• bitmap: A bitmap to display. If this value is set, icon is ignored.
• icon: An icon to display

Control events:

• OnImageFrameClick: When the image frame is clicked once by the user
• OnImageFrameDoubleClick: When the image frame is clicked twice rapidly by the user
• MousePress(_): Generic mouse press events on the button
• OnMouseMove: Generic mouse mouse event
• OnMouseWheel: Generic mouse wheel event

use native_windows_gui as nwg;
fn build_frame(button: &mut nwg::ImageFrame, window: &nwg::Window, ico: &nwg::Icon) {
    nwg::ImageFrame::builder()
        .parent(window)
        .build(button);
}

Fields

handle: ControlHandle

Implementations

impl ImageFrame

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

pub fn set_bitmap<'a>(&self, image: Option<&'a Bitmap>)

Sets the bitmap image of the image frame. Replace the current bitmap or icon. Set image to None to remove the image

pub fn set_icon<'a>(&self, image: Option<&'a Icon>)

Sets the bitmap image of the image frame. Replace the current bitmap or icon. Set image to None to remove the image

pub fn image<'a>(&self, bitmap: &mut Option<Bitmap>, icon: &mut Option<Icon>)

Returns the current image in the image frame. If the image frame has a bitmap, the value will be returned in bitmap If the image frame has a icon, the value will be returned in icon

pub fn enabled(&self) -> bool

Return true if the control user can interact with the control, return false otherwise

pub fn set_enabled(&self, v: bool)

Enable or disable the control

pub fn visible(&self) -> bool

Return true if the control is visible to the user. Will return true even if the control is outside of the parent client view (ex: at the position (10000, 10000))

pub fn set_visible(&self, v: bool)

Show or hide the control to the user

pub fn size(&self) -> (u32, u32)

Return the size of the image frame in the parent window

pub fn set_size(&self, x: u32, y: u32)

Set the size of the image frame in the parent window

pub fn position(&self) -> (i32, i32)

Return the position of the image frame in the parent window

pub fn set_position(&self, x: i32, y: i32)

Set the position of the image frame in the parent window

pub fn class_name(&self) -> &'static str

Winapi class name used during control creation

pub fn flags(&self) -> u32

Winapi base flags used during window creation

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations

impl Default for ImageFrame

fn default() -> ImageFrame

Returns the “default value” for a type.

impl Drop for ImageFrame

fn drop(&mut self)

Executes the destructor for this type.

impl From<&ImageFrame> for ControlHandle

fn from(control: &ImageFrame) -> Self

Converts to this type from the input type.

impl From<&mut ImageFrame> for ControlHandle

fn from(control: &mut ImageFrame) -> Self

Converts to this type from the input type.

impl PartialEq<ControlHandle> for ImageFrame

fn eq(&self, other: &ControlHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ImageFrame> for ControlHandle

fn eq(&self, other: &ImageFrame) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ImageFrame> for ImageFrame

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.