Struct Mode 

#[repr(C)]
pub struct Mode {

    pub abi_version: c_uint,
    pub name: *mut c_char,
    pub cfg_name_key: [c_char; 128],
    pub display_name: *mut c_char,
    pub _init: ModeInit,
    pub _destroy: ModeDestroy,
    pub _get_num_entries: ModeGetNumEntries,
    pub _result: ModeResult,
    pub _token_match: ModeTokenMatch,
    pub _get_display_value: ModeGetDisplayValue,
    pub _get_icon: ModeGetIcon,
    pub _get_completion: ModeGetCompletion,
    pub _preprocess_input: ModePreprocessInput,
    pub _get_message: ModeGetMessage,
    pub private_data: *mut c_void,
    pub free: ModeFree,
    pub _create: ModeCreate,
    pub _completer_result: ModeCompleterResult,
    pub ed: *mut c_void,
    pub module: *mut GModule,
    pub fallback_icon_fetch_uid: u32,
    pub fallback_icon_not_found: u32,
    pub type: ModeType,
}

Structure defining a switcher.

Access should be done through mode_* functions, not the function pointer fields on this type.

It consists of a name, callback and if enabled a textbox for the sidebar-mode.

Fields

abi_version: c_uint

Used for external plugins.

You should set this to ABI_VERSION.

name: *mut c_char

Name (max 31 char long)

cfg_name_key: [c_char; 128]

display_name: *mut c_char

_init: ModeInit

Initialize the Mode.

Returns true if successful.

_destroy: ModeDestroy

Destroy the switcher, e.g. free all its memory. Still ready to restart.

_get_num_entries: ModeGetNumEntries

Get the number of entries to display (unfiltered).

_result: ModeResult

Process the result of the user selection.

_token_match: ModeTokenMatch

Token match for the matching algorithm.

_get_display_value: ModeGetDisplayValue

Get the string to display for the entry.

_get_icon: ModeGetIcon

Obtains the icon of the entry if available.

_get_completion: ModeGetCompletion

Obtains the string to complete.

_preprocess_input: ModePreprocessInput

Preprocess the input for sorting.

_get_message: ModeGetMessage

Message to show in the message bar.

private_data: *mut c_void

Pointer to private data.

free: ModeFree

Free the switcher.

_create: ModeCreate

Create mode.

_completer_result: ModeCompleterResult

If this mode is used as a completer.

ed: *mut c_void

Extra fields for the script.

module: *mut GModule

Module

fallback_icon_fetch_uid: u32

Fallback icon

fallback_icon_not_found: u32

Fallback icon

type: ModeType

Type.

Implementations

impl Mode

pub const fn default() -> Self

Create a Mode with all None/null fields.

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl Default for Mode

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Mode

impl Sync for Mode