Struct obs_sys::obs_modal_ui

#[repr(C)]
pub struct obs_modal_ui {
    pub id: *const c_char,
    pub task: *const c_char,
    pub target: *const c_char,
    pub exec: Option<unsafe extern "C" fn(object: *mut c_void, ui_data: *mut c_void) -> bool>,
    pub type_data: *mut c_void,
    pub free_type_data: Option<unsafe extern "C" fn(type_data: *mut c_void)>,
}

Modal UI definition structure

Fields

id: *const c_char

< Identifier associated with this UI

task: *const c_char

< Task of the UI

target: *const c_char

< UI target (UI toolkit or program name)

exec: Option<unsafe extern "C" fn(object: *mut c_void, ui_data: *mut c_void) -> bool>

Callback to execute modal interface.

The @b object variable points to the input/output/encoder/etc. The @b ui_data variable points to the UI parent or UI-specific data to be used with the custom user interface.

What @b ui_data points to differs depending on the target, and you should use discretion and consistency when using this variable to relay information to the UI function. For example, it would be ideal to have @b ui_data point to a parent, QWidget for Qt, or a wxWindow for wxWidgets, etc., though it’s up to the discretion of the developer to define that value. Because of the nature of void pointers, discretion and consistency is advised.

@param object Pointer/handle to the data associated with this call. @param ui_data UI data to pass associated with this specific target, if any. @return @b true if user completed the task, or @b false if user cancelled the task.

type_data: *mut c_void

free_type_data: Option<unsafe extern "C" fn(type_data: *mut c_void)>

Trait Implementations

impl Clone for obs_modal_ui

fn clone(&self) -> obs_modal_ui

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for obs_modal_ui

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for obs_modal_ui

fn default() -> Self

Returns the “default value” for a type.

impl Copy for obs_modal_ui