Struct EventIsOwned

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

An event is a structure holding information about an event passed to a callback or member function.

• Event represents a C++ wxEvent class instance which your code has ownership, EventIsOwned<false> represents one which don’t own.
• Use Event’s new() to create an instance of this class.
• See C++ wxEvent class’s documentation for more details.

Implementations

impl<const OWNED: bool> EventIsOwned<OWNED>

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

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

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

fn class_info() -> ClassInfoIsOwned<false>

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

impl<const OWNED: bool> EventMethods for EventIsOwned<OWNED>

fn clone(&self) -> Event

Returns a copy of the event.

fn get_event_object(&self) -> Option<ObjectIsOwned<false>>

Returns the object (usually a window) associated with the event, if any.

fn get_id(&self) -> c_int

Returns the identifier associated with this event, such as a button command id.

fn get_event_user_data(&self) -> Option<ObjectIsOwned<false>>

Return the user data associated with a dynamically connected event handler.

fn get_skipped(&self) -> bool

Returns true if the event handler should be skipped, false otherwise.

fn get_timestamp(&self) -> c_long

Gets the timestamp for the event.

fn is_command_event(&self) -> bool

Returns true if the event is or is derived from wxCommandEvent else it returns false.

fn resume_propagation(&self, propagation_level: c_int)

Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation).

fn set_event_object<O: ObjectMethods>(&self, object: Option<&O>)

Sets the originating object.

fn set_id(&self, id: c_int)

Sets the identifier associated with this event, such as a button command id.

fn set_timestamp(&self, time_stamp: c_long)

Sets the timestamp for the event.

fn should_propagate(&self) -> bool

Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.

fn skip(&self, skip: bool)

This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns.

fn stop_propagation(&self) -> c_int

Stop the event from propagating to its parent window.

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

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

Converts to this type from the input type.

impl<const OWNED: bool> From<TimerEventIsOwned<OWNED>> for EventIsOwned<OWNED>

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

Converts to this type from the input type.

impl<const OWNED: bool> ObjectMethods for EventIsOwned<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: ClassInfoMethods>(&self, info: Option<&C>) -> bool

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

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

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

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

Makes this object refer to the data in clone.

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

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 EventIsOwned<OWNED>

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