girara
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Typedefs | Functions
callbacks.h File Reference
#include "types.h"
#include <gtk/gtk.h>

Go to the source code of this file.

Typedefs

typedef bool(* girara_callback_inputbar_key_press_event_t )(GtkWidget *widget, GdkEventKey *event, void *data)
typedef bool(* girara_callback_inputbar_activate_t )(GtkEntry *entry, void *data)

Functions

bool girara_callback_view_key_press_event (GtkWidget *widget, GdkEventKey *event, girara_session_t *session)
bool girara_callback_view_button_press_event (GtkWidget *widget, GdkEventButton *button, girara_session_t *session)
bool girara_callback_view_button_release_event (GtkWidget *widget, GdkEventButton *button, girara_session_t *session)
bool girara_callback_view_button_motion_notify_event (GtkWidget *widget, GdkEventMotion *button, girara_session_t *session)
bool girara_callback_view_scroll_event (GtkWidget *widget, GdkEventScroll *event, girara_session_t *session)
bool girara_callback_inputbar_activate (GtkEntry *entry, girara_session_t *session)
bool girara_callback_inputbar_key_press_event (GtkWidget *widget, GdkEventKey *event, girara_session_t *session)
bool girara_callback_inputbar_changed_event (GtkEditable *widget, girara_session_t *session)

Typedef Documentation

typedef bool(* girara_callback_inputbar_activate_t)(GtkEntry *entry, void *data)

Callback definition for an inputbar key press event handler

Parameters
entryThe inputbar
dataCustom data
Returns
true if no error occured

Definition at line 27 of file callbacks.h.

typedef bool(* girara_callback_inputbar_key_press_event_t)(GtkWidget *widget, GdkEventKey *event, void *data)

Callback definition for an inputbar key press event handler

Parameters
widgetThe widget
eventEvent
dataCustom data
Returns
true if no error occured

Definition at line 17 of file callbacks.h.

Function Documentation

bool girara_callback_inputbar_activate ( GtkEntry *  entry,
girara_session_t *  session 
)

Default callback if the inputbar gets activated

Parameters
entryThe inputbar entry
sessionThe used girara session
Returns
TRUE No error occured
FALSE An error occured

Definition at line 324 of file callbacks.c.

bool girara_callback_inputbar_changed_event ( GtkEditable *  widget,
girara_session_t *  session 
)

Default callback if the text of the input bar has changed

Parameters
widgetThe used widget
sessionThe used girara session
Returns
TRUE No error occured
FALSE An error occured

Definition at line 490 of file callbacks.c.

bool girara_callback_inputbar_key_press_event ( GtkWidget *  widget,
GdkEventKey *  event,
girara_session_t *  session 
)

Default callback if an key in the input bar gets pressed

Parameters
widgetThe used widget
eventThe occured event
sessionThe used girara session
Returns
TRUE No error occured
FALSE An error occured

Definition at line 440 of file callbacks.c.

bool girara_callback_view_button_motion_notify_event ( GtkWidget *  widget,
GdkEventMotion *  button,
girara_session_t *  session 
)

Default callback when the pointer moves over the widget

Parameters
widgetThe used widget
buttonThe event motion that triggered the event
sessionThe used girara session
Returns
true to stop other handlers from being invoked for the event.
false to propagate the event further.
bool girara_callback_view_button_press_event ( GtkWidget *  widget,
GdkEventButton *  button,
girara_session_t *  session 
)

Default callback when a button (typically a mouse button) has been pressed

Parameters
widgetThe used widget
buttonThe button that triggered the event
sessionThe used girara session
Returns
true to stop other handlers from being invoked for the event.
false to propagate the event further.
bool girara_callback_view_button_release_event ( GtkWidget *  widget,
GdkEventButton *  button,
girara_session_t *  session 
)

Default callback when a button (typically a mouse button) has been released

Parameters
widgetThe used widget
buttonThe button that triggered the event
sessionThe used girara session
Returns
true to stop other handlers from being invoked for the event.
false to propagate the event further.
bool girara_callback_view_key_press_event ( GtkWidget *  widget,
GdkEventKey *  event,
girara_session_t *  session 
)

Default callback for key press events in the view area

Parameters
widgetThe used widget
eventThe occured event
sessionThe used girara session
Returns
TRUE No error occured
FALSE An error occured
bool girara_callback_view_scroll_event ( GtkWidget *  widget,
GdkEventScroll *  event,
girara_session_t *  session 
)

Default callback then a scroll event is triggered by the view

Parameters
widgetThe widget
eventThe event motion
sessionThe girara session
Returns
true to stop other handlers from being invoked for the event.
false to propagate the event further.