Struct ColourIsOwned

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

A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values and an Alpha value, and is used to determine drawing colours.

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

Implementations

impl<const OWNED: bool> ColourIsOwned<OWNED>

pub fn new() -> ColourIsOwned<OWNED>

Default constructor.

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

pub fn new_with_str(colour_name: &str) -> ColourIsOwned<OWNED>

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

pub fn new_with_colour<C: ColourMethods>(colour: &C) -> ColourIsOwned<OWNED>

Copy constructor.

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

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

Trait Implementations

impl Clone for ColourIsOwned<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> ColourMethods for ColourIsOwned<OWNED>

fn get_alpha(&self) -> c_uint

Returns the alpha value, on platforms where alpha is not yet supported, this always returns wxALPHA_OPAQUE.

fn get_blue(&self) -> c_uint

Returns the blue intensity as unsigned int.

fn get_green(&self) -> c_uint

Returns the green intensity as unsigned int.

fn get_red(&self) -> c_uint

Returns the red intensity as unsigned int.

fn get_as_string(&self, flags: c_long) -> String

Converts this colour to a wxString using the given flags.

fn get_luminance(&self) -> c_double

Return the perceived brightness of the colour.

fn is_ok(&self) -> bool

Returns true if the colour object is valid (the colour has been initialised with RGB values).

fn is_solid(&self) -> bool

Returns true if the color can be described using RGB values, i.e.

fn set(&self, str: &str) -> bool

See C++ wxColour::Set()’s documentation.

fn make_mono(r: *mut c_void, g: *mut c_void, b: *mut c_void, on: bool)

Assigns the same value to r, g, b: 0 if on is false, 255 otherwise.

fn make_grey(r: *mut c_void, g: *mut c_void, b: *mut c_void)

Create a grey colour from (in/out) rgb parameters using integer arithmetic.

fn make_grey_double( r: *mut c_void, g: *mut c_void, b: *mut c_void, weight_r: c_double, weight_g: c_double, weight_b: c_double, )

Create a grey colour from (in/out) rgb parameters using floating point arithmetic.

fn change_lightness( r: *mut c_void, g: *mut c_void, b: *mut c_void, ialpha: c_int, )

Utility function that simply darkens or lightens a color, based on the specified percentage ialpha.

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

fn drop(&mut self)

Executes the destructor for this type.

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

fn class_info() -> ClassInfoIsOwned<false>

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

where T: DynamicCast,

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

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

Converts to this type from the input type.

impl<const OWNED: bool> ObjectMethods for ColourIsOwned<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 ColourIsOwned<OWNED>

type Unowned = ColourIsOwned<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,