#include <gmodule.h>
Go to the source code of this file.
|
typedef void(* | _mode_free) (Mode *data) |
|
typedef char *(* | _mode_get_display_value) (const Mode *sw, unsigned int selected_line, int *state, GList **attribute_list, int get_entry) |
|
typedef cairo_surface_t *(* | _mode_get_icon) (const Mode *sw, unsigned int selected_line, int height) |
|
typedef char *(* | _mode_get_completion) (const Mode *sw, unsigned int selected_line) |
|
typedef int(* | _mode_token_match) (const Mode *data, rofi_int_matcher **tokens, unsigned int index) |
|
typedef int(* | __mode_init) (Mode *sw) |
|
typedef unsigned int(* | __mode_get_num_entries) (const Mode *sw) |
|
typedef void(* | __mode_destroy) (Mode *sw) |
|
typedef ModeMode(* | _mode_result) (Mode *sw, int menu_retv, char **input, unsigned int selected_line) |
|
typedef char *(* | _mode_preprocess_input) (Mode *sw, const char *input) |
|
typedef char *(* | _mode_get_message) (const Mode *sw) |
|
◆ ABI_VERSION
#define ABI_VERSION 0x00000006 |
ABI version to check if loaded plugin is compatible.
Definition at line 34 of file mode-private.h.
◆ __mode_destroy
typedef void(* __mode_destroy) (Mode *sw) |
- Parameters
-
Destroy the current mode. Still ready to restart.
Definition at line 120 of file mode-private.h.
◆ __mode_get_num_entries
typedef unsigned int(* __mode_get_num_entries) (const Mode *sw) |
- Parameters
-
Get the number of entries.
- Returns
- the number of entries
Definition at line 112 of file mode-private.h.
◆ __mode_init
typedef int(* __mode_init) (Mode *sw) |
- Parameters
-
Initialize the mode.
- Returns
- TRUE is successful
Definition at line 103 of file mode-private.h.
◆ _mode_free
typedef void(* _mode_free) (Mode *data) |
- Parameters
-
data | Pointer to Mode object. |
Mode free function.
Definition at line 41 of file mode-private.h.
◆ _mode_get_completion
typedef char*(* _mode_get_completion) (const Mode *sw, unsigned int selected_line) |
- Parameters
-
sw | The Mode pointer |
selected_line | The selected line |
Obtains the string to complete.
- Returns
- Get the completion string
Definition at line 79 of file mode-private.h.
◆ _mode_get_display_value
typedef char*(* _mode_get_display_value) (const Mode *sw, unsigned int selected_line, int *state, GList **attribute_list, int get_entry) |
- Parameters
-
sw | The Mode pointer |
selected_line | The selected line |
state | The state to display [out] |
attribute_list | List of extra (pango) attribute to apply when displaying. [out][null] |
get_entry | if it should only return the state |
Get the value for displaying.
- Returns
- the string and state for displaying.
Definition at line 55 of file mode-private.h.
◆ _mode_get_icon
typedef cairo_surface_t*(* _mode_get_icon) (const Mode *sw, unsigned int selected_line, int height) |
- Parameters
-
sw | The Mode pointer |
selected_line | The selected line |
Obtains the icon if available
- Returns
- Get the icon
Definition at line 67 of file mode-private.h.
◆ _mode_get_message
typedef char*(* _mode_get_message) (const Mode *sw) |
- Parameters
-
Message to show in the message bar.
- Returns
- the (valid pango markup) message to display.
Definition at line 152 of file mode-private.h.
◆ _mode_preprocess_input
typedef char*(* _mode_preprocess_input) (Mode *sw, const char *input) |
- Parameters
-
sw | The Mode pointer |
input | The input string |
Preprocess the input for sorting.
- Returns
- Entry stripped from markup for sorting
Definition at line 143 of file mode-private.h.
◆ _mode_result
typedef ModeMode(* _mode_result) (Mode *sw, int menu_retv, char **input, unsigned int selected_line) |
- Parameters
-
sw | The Mode pointer |
menu_retv | The return value |
input | The input string |
selected_line | The selected line |
Handle the user accepting an entry.
- Returns
- the next action to take
Definition at line 132 of file mode-private.h.
◆ _mode_token_match
- Parameters
-
tokens | List of (input) tokens to match. |
input | The entry to match against. |
case_sensitive | Whether case is significant. |
index | The current selected index. |
data | User data. |
Function prototype for the matching algorithm.
- Returns
- 1 when it matches, 0 if not.
Definition at line 93 of file mode-private.h.