rofi/include/mode-private.h
2016-01-12 22:18:10 +01:00

81 lines
2.6 KiB
C

#ifndef ROFI_MODE_PRIVATE_H
#define ROFI_MODE_PRIVATE_H
typedef void ( *_mode_free )( Mode *data );
typedef char * ( *_mode_get_display_value )( const Mode *sw, unsigned int selected_line, int *state, int get_entry );
typedef char * ( *_mode_get_completion )( const Mode *sw, unsigned int selected_line );
/**
* @param tokens List of (input) tokens to match.
* @param input The entry to match against.
* @param case_sensitive Whether case is significant.
* @param index The current selected index.
* @param data User data.
*
* Function prototype for the matching algorithm.
*
* @returns 1 when it matches, 0 if not.
*/
typedef int ( *_mode_token_match )( const Mode *data, char **tokens, int not_ascii, int case_sensitive, 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 int ( *_mode_is_not_ascii )( const Mode *sw, unsigned int index );
/**
* Structure defining a switcher.
* It consists of a name, callback and if enabled
* a textbox for the sidebar-mode.
*/
struct _Mode
{
/** Name (max 31 char long) */
char name[32];
char cfg_name_key[128];
char *display_name;
/** Keybindings (keysym and modmask) */
char * keycfg;
char * keystr;
KeySym keysym;
unsigned int modmask;
/**
* A switcher normally consists of the following parts:
*/
/** Initialize the Mode */
__mode_init _init;
/** Destroy the switcher, e.g. free all its memory. */
__mode_destroy _destroy;
/** Get number of entries to display. (unfiltered). */
__mode_get_num_entries _get_num_entries;
/** Check if the element is ascii. */
_mode_is_not_ascii _is_not_ascii;
/** Process the result of the user selection. */
_mode_result _result;
/** Token match. */
_mode_token_match _token_match;
/** Get the string to display for the entry. */
_mode_get_display_value _get_display_value;
/** Get the 'completed' entry. */
_mode_get_completion _get_completion;
/** Pointer to private data. */
void *private_data;
/**
* Free SWitcher
* Only to be used when the switcher object itself is dynamic.
* And has data in `ed`
*/
_mode_free free;
/** Extra fields for script */
void *ed;
};
#endif // ROFI_MODE_PRIVATE_H