Struct ImageFrame

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

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§

Source§

impl ImageFrame

Source

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

Source

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

Source

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

Source

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

Source

pub fn enabled(&self) -> bool

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

Source

pub fn set_enabled(&self, v: bool)

Enable or disable the control

Source

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

Source

pub fn set_visible(&self, v: bool)

Show or hide the control to the user

Source

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

Return the size of the image frame in the parent window

Source

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

Set the size of the image frame in the parent window

Source

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

Return the position of the image frame in the parent window

Source

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

Set the position of the image frame in the parent window

Source

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

Winapi class name used during control creation

Source

pub fn flags(&self) -> u32

Winapi base flags used during window creation

Source

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations§

Source§

impl Default for ImageFrame

Source§

fn default() -> ImageFrame

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

impl Drop for ImageFrame

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl From<&ImageFrame> for ControlHandle

Source§

fn from(control: &ImageFrame) -> Self

Converts to this type from the input type.
Source§

impl From<&mut ImageFrame> for ControlHandle

Source§

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

Converts to this type from the input type.
Source§

impl PartialEq<ControlHandle> for ImageFrame

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<ImageFrame> for ControlHandle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq for ImageFrame

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

Auto Trait Implementations§

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

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

Source§

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.