Trait EvtHandlerMethods

pub trait EvtHandlerMethods: ObjectMethods {
    // Provided methods
    fn queue_event<E: EventMethods>(&self, event: Option<&E>) { ... }
    fn add_pending_event<E: EventMethods>(&self, event: &E) { ... }
    fn process_event<E: EventMethods>(&self, event: &E) -> bool { ... }
    fn process_event_locally<E: EventMethods>(&self, event: &E) -> bool { ... }
    fn safely_process_event<E: EventMethods>(&self, event: &E) -> bool { ... }
    fn process_pending_events(&self) { ... }
    fn delete_pending_events(&self) { ... }
    fn get_client_object(&self) -> Option<ClientDataIsOwned<false>> { ... }
    fn set_client_object<C: ClientDataMethods>(&self, data: Option<&C>) { ... }
    fn get_evt_handler_enabled(&self) -> bool { ... }
    fn get_next_handler(&self) -> WeakRef<EvtHandler> { ... }
    fn get_previous_handler(&self) -> WeakRef<EvtHandler> { ... }
    fn set_evt_handler_enabled(&self, enabled: bool) { ... }
    fn set_next_handler<E: EvtHandlerMethods>(&self, handler: Option<&E>) { ... }
    fn set_previous_handler<E: EvtHandlerMethods>(&self, handler: Option<&E>) { ... }
    fn unlink(&self) { ... }
    fn is_unlinked(&self) -> bool { ... }
    fn add_filter(filter: *mut c_void) { ... }
    fn remove_filter(filter: *mut c_void) { ... }
}

This trait represents C++ wxEvtHandler class’s methods and inheritance.

See EvtHandlerIsOwned documentation for the class usage.

Provided Methods

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

Queue event for a later processing.

See C++ wxEvtHandler::QueueEvent()’s documentation.

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

Post an event to be processed later.

See C++ wxEvtHandler::AddPendingEvent()’s documentation.

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

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

See C++ wxEvtHandler::ProcessEvent()’s documentation.

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

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

See C++ wxEvtHandler::ProcessEventLocally()’s documentation.

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

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

See C++ wxEvtHandler::SafelyProcessEvent()’s documentation.

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.

See C++ wxEvtHandler::ProcessPendingEvents()’s documentation.

fn delete_pending_events(&self)

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

See C++ wxEvtHandler::DeletePendingEvents()’s documentation.

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

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

See C++ wxEvtHandler::GetClientObject()’s documentation.

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

Set the client data object.

See C++ wxEvtHandler::SetClientObject()’s documentation.

fn get_evt_handler_enabled(&self) -> bool

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

See C++ wxEvtHandler::GetEvtHandlerEnabled()’s documentation.

fn get_next_handler(&self) -> WeakRef<EvtHandler>

Returns the pointer to the next handler in the chain.

See C++ wxEvtHandler::GetNextHandler()’s documentation.

fn get_previous_handler(&self) -> WeakRef<EvtHandler>

Returns the pointer to the previous handler in the chain.

See C++ wxEvtHandler::GetPreviousHandler()’s documentation.

fn set_evt_handler_enabled(&self, enabled: bool)

Enables or disables the event handler.

See C++ wxEvtHandler::SetEvtHandlerEnabled()’s documentation.

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

Sets the pointer to the next handler.

See C++ wxEvtHandler::SetNextHandler()’s documentation.

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

Sets the pointer to the previous handler.

See C++ wxEvtHandler::SetPreviousHandler()’s documentation.

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

See C++ wxEvtHandler::Unlink()’s documentation.

fn is_unlinked(&self) -> bool

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

See C++ wxEvtHandler::IsUnlinked()’s documentation.

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.

See C++ wxEvtHandler::AddFilter()’s documentation.

fn remove_filter(filter: *mut c_void)

Remove a filter previously installed with AddFilter().

See C++ wxEvtHandler::RemoveFilter()’s documentation.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

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

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