Struct EventBlockerIsOwned

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

This class is a special event handler which allows discarding any event (or a set of event types) directed to a specific window.

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

Implementations

impl<const OWNED: bool> EventBlockerIsOwned<OWNED>

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

Trait Implementations

impl<const OWNED: bool> Clone for EventBlockerIsOwned<OWNED>

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> DynamicCast for EventBlockerIsOwned<OWNED>

fn class_info() -> ClassInfoIsOwned<false>

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

where T: DynamicCast,

impl<const OWNED: bool> EvtHandlerMethods for EventBlockerIsOwned<OWNED>

fn queue_event<E>(&self, event: Option<&E>)

where E: EventMethods,

Queue event for a later processing.

fn add_pending_event<E>(&self, event: &E)

where E: EventMethods,

Post an event to be processed later.

fn process_event<E>(&self, event: &E) -> bool

where E: EventMethods,

Processes an event, searching event tables and calling zero or more suitable event handler function(s).

fn process_event_locally<E>(&self, event: &E) -> bool

where E: EventMethods,

Try to process the event in this handler and all those chained to it.

fn safely_process_event<E>(&self, event: &E) -> bool

where E: EventMethods,

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

fn process_pending_events(&self)

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

fn delete_pending_events(&self)

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

fn get_client_object(&self) -> Option<ClientDataIsOwned<false>>

Returns a pointer to the user-supplied client data object.

fn set_client_object<C>(&self, data: Option<&C>)

where C: ClientDataMethods,

Set the client data object.

fn get_evt_handler_enabled(&self) -> bool

Returns true if the event handler is enabled, false otherwise.

fn get_next_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>

Returns the pointer to the next handler in the chain.

fn get_previous_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>

Returns the pointer to the previous handler in the chain.

fn set_evt_handler_enabled(&self, enabled: bool)

Enables or disables the event handler.

fn set_next_handler<E>(&self, handler: Option<&E>)

where E: EvtHandlerMethods,

Sets the pointer to the next handler.

fn set_previous_handler<E>(&self, handler: Option<&E>)

where E: EvtHandlerMethods,

Sets the pointer to the previous handler.

fn unlink(&self)

Unlinks this event handler from the chain it’s part of (if any); then links the “previous” event handler to the “next” one (so that the chain won’t be interrupted).

fn is_unlinked(&self) -> bool

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

fn add_filter(filter: *mut c_void)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

fn remove_filter(filter: *mut c_void)

Remove a filter previously installed with AddFilter().

impl<const OWNED: bool> From<EventBlockerIsOwned<OWNED>> for EvtHandlerIsOwned<OWNED>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

type Unowned = EventBlockerIsOwned<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> EventBlockerMethods for EventBlockerIsOwned<OWNED>