Struct BitmapIsOwned

pub struct BitmapIsOwned<const OWNED: bool>(/* private fields */);

This class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour or colour with alpha channel support.

• Bitmap represents a C++ wxBitmap class instance which your code has ownership, BitmapIsOwned<false> represents one which don’t own.
• Use Bitmap’s new() or Buildable::builder() (if available) to create an instance of this class.
• See C++ wxBitmap class’s documentation for more details.

Implementations

impl<const OWNED: bool> BitmapIsOwned<OWNED>

pub fn new() -> BitmapIsOwned<OWNED>

Default constructor.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn new_with_bitmap<B: BitmapMethods>(bitmap: &B) -> BitmapIsOwned<OWNED>

Copy constructor, uses reference counting.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn new_with_int_int( width: c_int, height: c_int, depth: c_int, ) -> BitmapIsOwned<OWNED>

Creates a new bitmap.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn new_with_size<S: SizeMethods>( sz: &S, depth: c_int, ) -> BitmapIsOwned<OWNED>

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn new_with_int_dc<D: DCMethods>( width: c_int, height: c_int, dc: &D, ) -> BitmapIsOwned<OWNED>

Create a bitmap compatible with the given DC, inheriting its magnification factor.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn new_with_char(bits: *const c_void) -> BitmapIsOwned<OWNED>

Creates a bitmap from XPM data.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn new_with_image_int<I: ImageMethods>( img: &I, depth: c_int, ) -> BitmapIsOwned<OWNED>

Creates this bitmap object from the given image.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn new_with_image_dc<I: ImageMethods, D: DCMethods>( img: &I, dc: &D, ) -> BitmapIsOwned<OWNED>

Creates a bitmap compatible with the given DC from the given image.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn new_with_cursor<C: CursorMethods>(cursor: &C) -> BitmapIsOwned<OWNED>

Creates bitmap corresponding to the given cursor.

See C++ wxBitmap::wxBitmap()’s documentation.

pub fn none() -> Option<&'static Self>

Trait Implementations

impl<const OWNED: bool> BitmapMethods for BitmapIsOwned<OWNED>

fn convert_to_image(&self) -> Image

Creates an image from a platform-dependent bitmap.

fn copy_from_icon<I: IconMethods>(&self, icon: &I) -> bool

Creates the bitmap from an icon.

fn create_int_int(&self, width: c_int, height: c_int, depth: c_int) -> bool

Creates a fresh bitmap.

fn create_size<S: SizeMethods>(&self, sz: &S, depth: c_int) -> bool

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn create_int_dc<D: DCMethods>( &self, width: c_int, height: c_int, dc: &D, ) -> bool

Create a bitmap compatible with the given DC, inheriting its magnification factor.

fn create_with_dip_size_size<S: SizeMethods>( &self, size: &S, scale: c_double, depth: c_int, ) -> bool

Create a bitmap specifying its size in DPI-independent pixels and the scale factor to use.

fn create_with_dip_size_int( &self, width: c_int, height: c_int, scale: c_double, depth: c_int, ) -> bool

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn create_scaled( &self, width: c_int, height: c_int, depth: c_int, logical_scale: c_double, ) -> bool

Create a bitmap with a scale factor.

fn get_depth(&self) -> c_int

Gets the colour depth of the bitmap.

fn get_dip_size(&self) -> Size

Returns the size of bitmap in DPI-independent units.

fn get_height(&self) -> c_int

Returns the height of the bitmap in physical pixels.

fn get_logical_height(&self) -> c_double

Returns the height of the bitmap in logical pixels.

fn get_logical_size(&self) -> Size

Returns the size of the bitmap in logical pixels.

fn get_logical_width(&self) -> c_double

Returns the width of the bitmap in logical pixels.

fn get_mask(&self) -> Option<MaskIsOwned<false>>

Gets the associated mask (if any) which may have been loaded from a file or set for the bitmap.

fn get_palette(&self) -> Option<PaletteIsOwned<false>>

Gets the associated palette (if any) which may have been loaded from a file or set for the bitmap.

fn get_sub_bitmap<R: RectMethods>(&self, rect: &R) -> Bitmap

Returns a sub bitmap of the current one as long as the rect belongs entirely to the bitmap.

fn get_scale_factor(&self) -> c_double

Returns the scale factor of this bitmap.

fn get_scaled_height(&self) -> c_double

Returns the height of the bitmap in logical pixels.

fn get_scaled_size(&self) -> Size

Returns the size of the bitmap in logical pixels.

fn get_scaled_width(&self) -> c_double

Returns the width of the bitmap in logical pixels.

fn get_size(&self) -> Size

Returns the size of the bitmap in physical pixels.

fn get_width(&self) -> c_int

Returns the width of the bitmap in physical pixels.

fn has_alpha(&self) -> bool

Returns true if the bitmap has an alpha channel.

fn is_ok(&self) -> bool

Returns true if bitmap data is present.

fn set_scale_factor(&self, scale: c_double)

Sets the bitmap scale factor.

fn set_mask<M: MaskMethods>(&self, mask: Option<&M>)

Sets the mask for this bitmap.

fn set_palette<P: PaletteMethods>(&self, palette: &P)

Sets the associated palette.

fn add_handler<B: BitmapHandlerMethods>(handler: Option<&B>)

Adds a handler to the end of the static list of format handlers.

fn clean_up_handlers()

Deletes all bitmap handlers.

fn find_handler(name: &str) -> Option<BitmapHandlerIsOwned<false>>

Finds the handler with the given name.

fn init_standard_handlers()

Adds the standard bitmap format handlers, which, depending on wxWidgets configuration, can be handlers for Windows bitmap, Windows bitmap resource, and XPM.

fn insert_handler<B: BitmapHandlerMethods>(handler: Option<&B>)

Adds a handler at the start of the static list of format handlers.

fn new_from_png_data(data: *const c_void, size: usize) -> Bitmap

Loads a bitmap from the memory containing image data in PNG format.

fn remove_handler(name: &str) -> bool

Finds the handler with the given name, and removes it.

fn rescale<B: BitmapMethods, S: SizeMethods>(bmp: &B, size_needed: &S)

Rescale the given bitmap to the requested size.

impl Clone for BitmapIsOwned<false>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const OWNED: bool> Drop for BitmapIsOwned<OWNED>

fn drop(&mut self)

Executes the destructor for this type.

impl<const OWNED: bool> DynamicCast for BitmapIsOwned<OWNED>

fn class_info() -> ClassInfoIsOwned<false>

fn as_unowned<T>(&self) -> Option<<T as WxRustMethods>::Unowned>

where T: DynamicCast,

impl<const OWNED: bool> From<BitmapIsOwned<OWNED>> for GDIObjectIsOwned<OWNED>

fn from(o: BitmapIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> From<BitmapIsOwned<OWNED>> for ObjectIsOwned<OWNED>

fn from(o: BitmapIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl From<BitmapIsOwned<true>> for BitmapBundle

fn from(bitmap: Bitmap) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> ObjectMethods for BitmapIsOwned<OWNED>

fn get_class_info(&self) -> Option<ClassInfoIsOwned<false>>

This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).

fn get_ref_data(&self) -> Option<ObjectRefDataIsOwned<false>>

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

fn is_kind_of<C>(&self, info: Option<&C>) -> bool

where C: ClassInfoMethods,

Determines whether this class is a subclass of (or the same class as) the given class.

fn is_same_as<O>(&self, obj: &O) -> bool

where O: ObjectMethods,

Returns true if this object has the same data pointer as obj.

fn ref_<O>(&self, clone: &O)

where O: ObjectMethods,

Makes this object refer to the data in clone.

fn set_ref_data<O>(&self, data: Option<&O>)

where O: ObjectRefDataMethods,

Sets the wxObject::m_refData pointer.

fn un_ref(&self)

Decrements the reference count in the associated data, and if it is zero, deletes the data.

fn un_share(&self)

This is the same of AllocExclusive() but this method is public.

impl<const OWNED: bool> WxRustMethods for BitmapIsOwned<OWNED>

type Unowned = BitmapIsOwned<false>

unsafe fn as_ptr(&self) -> *mut c_void

unsafe fn from_ptr(ptr: *mut c_void) -> Self

unsafe fn from_unowned_ptr(ptr: *mut c_void) -> Self::Unowned

unsafe fn with_ptr<F: Fn(&Self)>(ptr: *mut c_void, closure: F)

unsafe fn option_from(ptr: *mut c_void) -> Option<Self::Unowned>

where Self: Sized,

impl<const OWNED: bool> GDIObjectMethods for BitmapIsOwned<OWNED>