Struct UpdateUIEventIsOwned

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

This class is used for pseudo-events which are called by wxWidgets to give an application the chance to update various user interface elements.

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

Implementations

impl<const OWNED: bool> UpdateUIEventIsOwned<OWNED>

pub fn new(command_id: c_int) -> UpdateUIEventIsOwned<OWNED>

Constructor.

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

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

Trait Implementations

impl Clone for UpdateUIEventIsOwned<false>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const OWNED: bool> CommandEventMethods for UpdateUIEventIsOwned<OWNED>

fn get_client_data(&self) -> *mut c_void

Returns client data pointer for a listbox or choice selection event (not valid for a deselection).

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

Returns client object pointer for a listbox or choice selection event (not valid for a deselection).

fn get_extra_long(&self) -> c_long

Returns extra information dependent on the event objects type.

fn get_int(&self) -> c_int

Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox.

fn get_selection(&self) -> c_int

Returns item index for a listbox or choice selection event (not valid for a deselection).

fn get_string(&self) -> String

Returns item string for a listbox or choice selection event.

fn is_checked(&self) -> bool

This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one.

fn is_selection(&self) -> bool

For a listbox or similar event, returns true if it is a selection, false if it is a deselection.

fn set_client_data(&self, client_data: *mut c_void)

Sets the client data for this event.

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

Sets the client object for this event.

fn set_extra_long(&self, extra_long: c_long)

Sets the m_extraLong member.

fn set_int(&self, int_command: c_int)

Sets the m_commandInt member.

fn set_string(&self, string: &str)

Sets the m_commandString member.

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

fn drop(&mut self)

Executes the destructor for this type.

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

fn class_info() -> ClassInfoIsOwned<false>

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

where T: DynamicCast,

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

fn clone(&self) -> EventIsOwned<true>

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

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

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: i32)

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

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

where O: ObjectMethods,

Sets the originating object.

fn set_id(&self, id: i32)

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

fn set_timestamp(&self, time_stamp: i64)

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

Stop the event from propagating to its parent window.

impl<const OWNED: bool> From<UpdateUIEventIsOwned<OWNED>> for CommandEventIsOwned<OWNED>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn check(&self, check: bool)

Check or uncheck the UI element.

fn enable(&self, enable: bool)

Enable or disable the UI element.

fn get_checked(&self) -> bool

Returns true if the UI element should be checked.

fn get_enabled(&self) -> bool

Returns true if the UI element should be enabled.

fn is_checkable(&self) -> bool

Returns true if the UI element can be checked.

fn get_set_checked(&self) -> bool

Returns true if the application has called Check().

fn get_set_enabled(&self) -> bool

Returns true if the application has called Enable().

fn get_set_shown(&self) -> bool

Returns true if the application has called Show().

fn get_set_text(&self) -> bool

Returns true if the application has called SetText().

fn get_shown(&self) -> bool

Returns true if the UI element should be shown.

fn get_text(&self) -> String

Returns the text that should be set for the UI element.

fn set_text(&self, text: &str)

Sets the text for this UI element.

fn show(&self, show: bool)

Show or hide the UI element.

fn can_update<W: WindowMethods>(window: Option<&W>) -> bool

Returns true if it is appropriate to update (send UI update events to) this window.

fn get_update_interval() -> c_long

Returns the current interval between updates in milliseconds.

fn reset_update_time()

Used internally to reset the last-updated time to the current time.

fn set_update_interval(update_interval: c_long)

Sets the interval between updates in milliseconds.

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

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