PolytreeDE
/
rofi
mirror of https://github.com/davatorium/rofi.git
1
0
Fork 0
Code Releases Activity

Doxy mode.h

This commit is contained in:
Dave Davenport 2016-01-08 09:29:15 +01:00
parent dc8fb4f202
commit 63a3552c63
1 changed files with 41 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
include/mode.h
View File

@ -107,7 +107,7 @@ char * mode_get_completion ( const Mode *mode, unsigned int selected_line );
int mode_is_not_ascii ( const Mode *mode, unsigned int selected_line );
/**
* @param mode Object The mode to query
* @param mode The mode to query
* @param mretv The menu return value.
* @param input Pointer to the user input string.
* @param selected_line the line selected by the user.
@ -119,7 +119,7 @@ int mode_is_not_ascii ( const Mode *mode, unsigned int selected_line );
ModeMode mode_result ( Mode *mode, int menu_retv, char **input, unsigned int selected_line );
/**
* @param mode Object The mode to query
* @param mode The mode to query
* @param tokens The set of tokens to match against
* @param not_ascii If the entry is pure-ascii
* @param case_sensitive If the entry should be matched case sensitive
@ -132,7 +132,7 @@ ModeMode mode_result ( Mode *mode, int menu_retv, char **input, unsigned int sel
int mode_token_match ( const Mode *mode, char **tokens, int not_ascii, int case_sensitive, unsigned int selected_line );
/**
* @param mode Object The mode to query
* @param mode The mode to query
*
* Get the name of the mode.
*
@ -141,7 +141,7 @@ int mode_token_match ( const Mode *mode, char **tokens, int not_ascii, int case_
const char * mode_get_name ( const Mode *mode );
/**
* @param mode Object The mode to query
* @param mode The mode to query
* @param key The KeySym to match
* @param state The Modmask to match
*
@ -152,24 +152,59 @@ const char * mode_get_name ( const Mode *mode );
int mode_check_keybinding ( const Mode *mode, KeySym key, unsigned int modstate );
/**
* @param mode Object The mode to query
* @param mode The mode to query
*
* Free the resources allocated for this mode.
*/
void mode_free ( Mode **mode );
/**
* @param mode Object The mode to query
* @param mode The mode to query
*
* Setup the keybinding for this mode.
*/
void mode_setup_keybinding ( Mode *mode );
/**
* @param mode The mode to query
* @param display The X Server display handle.
*
* Grab the key on the display.
* This first parses the key string and if successful asks X11 for a grab.
*
* return FALSE when key could not be grabbed.
*/
int mode_grab_key ( Mode *mode, Display *display );
/**
* @param mode The mode to query
* @param display The X Server display handle.
*
* Releases previously grabbed key.
*/
void mode_ungrab_key ( Mode *mode, Display *display );
/**
* @param mode The mode to query
*
* Print the current keybing for this mode to stdout.
*/
void mode_print_keybindings ( const Mode *mode );
/**
* @param mode The mode to query
*
* Helper functions for mode.
* Get the private data object.
*/
void *mode_get_private_data ( const Mode *mode );
/**
* @param mode The mode to query
*
* Helper functions for mode.
* Set the private data object.
*/
void mode_set_private_data ( Mode *mode, void *pd );
/*@}*/
#endif