zathura/shortcuts.h

199 lines
5.7 KiB
C
Raw Normal View History

2010-11-10 20:31:15 +01:00
/* See LICENSE file for license and copyright information */
#ifndef SHORTCUTS_H
#define SHORTCUTS_H
#include <girara.h>
2011-02-08 07:51:53 +01:00
/**
* Abort the current action and return to normal mode
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_abort(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Adjust the rendered pages to the window
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_adjust_window(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Change the current mode
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_change_mode(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Focus the inputbar
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_focus_inputbar(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Follow a link
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_follow(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Go to a specific page or position
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_goto(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Navigate through the document
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_navigate(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Recolor the pages
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_recolor(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Reload the current document
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_reload(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Rotate the pages
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_rotate(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Scroll through the pages
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_scroll(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Search through the document for the latest search item
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_search(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Navigate through the index of the document
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_navigate_index(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Show/Hide the index of the document
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_toggle_index(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Show/Hide the inputbar
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_toggle_inputbar(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Toggle fullscreen mode
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_toggle_fullscreen(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Show/Hide the statusbar
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_toggle_statusbar(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Quit zathura
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_quit(girara_session_t* session, girara_argument_t* argument, unsigned int t);
2011-02-08 07:51:53 +01:00
/**
* Change the zoom level
*
* @param session The used girara session
* @param argument The used argument
* @param t Number of executions
2011-02-08 07:51:53 +01:00
* @return true if no error occured otherwise false
*/
bool sc_zoom(girara_session_t* session, girara_argument_t* argument, unsigned int t);
#endif // SHORTCUTS_H