-
Notifications
You must be signed in to change notification settings - Fork 0
/
hints.h
72 lines (61 loc) · 1.55 KB
/
hints.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/* See LICENSE file for license and copyright information */
#ifndef HINTS_H
#define HINTS_H
#include <girara/types.h>
#include "jumanji.h"
/**
* Shortcut to enable hint mode
*
* @param session The used girara session
* @param argument The used argument
* @param event Girara event
* @param t Number of executions
* @return true if no error occured otherwise false
*/
bool sc_hints(girara_session_t* session, girara_argument_t* argument, girara_event_t* event, unsigned int t);
/**
* Callback to handle key press events
*
* @param widget The widget
* @param event The event
* @param jumanji The jumanji session
* @return true if no error occured
*/
bool cb_hints_key_press_event_add(GtkWidget* widget, GdkEventKey* event,
jumanji_t* jumanji);
/**
* Displays all hints
*
* @param jumanji
* @param tab
*/
void hints_show(jumanji_t* jumanji, jumanji_tab_t* tab);
/**
* Clears the hints from the web site
*
* @param jumanji Jumanji session
*/
void hints_clear(jumanji_t* jumanji);
/**
* Simulates a click on the hint
*
* @param jumanji Jumanji session
* @param n Index of the hint
* @return true if the hint has been processed
*/
bool hints_process(jumanji_t* jumanji, guint n);
/**
* Updates the current hints based on the input
*
* @param jumanji Jumanji session
* @param input Input
* @return true if a hint has been processed through the update
*/
bool hints_update(jumanji_t* jumanji, char* input);
/**
* Resets all hint settings
*
* @param jumanji The jumanji session
*/
void hints_reset(jumanji_t* jumanji);
#endif // HINTS_H