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

Go to the source code of this file.

Data Structures

struct  girara_session_t

Functions

girara_session_t * girara_session_create ()
bool girara_session_init (girara_session_t *session, const char *appname)
bool girara_session_destroy (girara_session_t *session)
bool girara_set_view (girara_session_t *session, GtkWidget *widget)
char * girara_buffer_get (girara_session_t *session)
void girara_notify (girara_session_t *session, int level, const char *format,...) GIRARA_PRINTF(3
void void girara_dialog (girara_session_t *session, const char *dialog, bool invisible, girara_callback_inputbar_key_press_event_t key_press_event, girara_callback_inputbar_activate_t activate_event, void *data)
girara_mode_t girara_mode_add (girara_session_t *session, const char *name)
void girara_mode_set (girara_session_t *session, girara_mode_t mode)
girara_mode_t girara_mode_get (girara_session_t *session)
bool girara_set_window_title (girara_session_t *session, const char *name)

Function Documentation

char* girara_buffer_get ( girara_session_t *  session)

Returns a copy of the buffer

Parameters:
sessionThe used girara session
Returns:
Copy of the current buffer

Definition at line 525 of file session.c.

void void girara_dialog ( girara_session_t *  session,
const char *  dialog,
bool  invisible,
girara_callback_inputbar_key_press_event_t  key_press_event,
girara_callback_inputbar_activate_t  activate_event,
void *  data 
)

Creates a girara dialog

Parameters:
sessionThe girara session
dialogThe dialog message
invisibleSets the input visibility
key_press_eventCallback function to a custom key press event handler
activate_eventCallback function to a custom activate event handler
dataCustom data that is passed to the callback functions

Definition at line 582 of file session.c.

girara_mode_t girara_mode_add ( girara_session_t *  session,
const char *  name 
)

Adds a new mode by its string identifier

Parameters:
sessionThe used girara session
nameThe string identifier used in configs/inputbar etc to refer by
Returns:
A newly defined girara_mode_t associated with name

Definition at line 642 of file session.c.

girara_mode_t girara_mode_get ( girara_session_t *  session)

Returns the current mode

Parameters:
sessionThe used girara session
Returns:
The current mode

Definition at line 675 of file session.c.

void girara_mode_set ( girara_session_t *  session,
girara_mode_t  mode 
)

Sets the current mode

Parameters:
sessionThe used girara session
modeThe new mode

Definition at line 634 of file session.c.

void girara_notify ( girara_session_t *  session,
int  level,
const char *  format,
  ... 
)

Displays a notification for the user. It is possible to pass GIRARA_INFO, GIRARA_WARNING or GIRARA_ERROR as a notification level.

Parameters:
sessionThe girara session
levelThe level
formatString format
...
girara_session_t* girara_session_create ( )

Creates a girara session

Returns:
A valid session object
NULL when an error occured

Definition at line 68 of file session.c.

bool girara_session_destroy ( girara_session_t *  session)

Destroys an girara session

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

Definition at line 455 of file session.c.

bool girara_session_init ( girara_session_t *  session,
const char *  appname 
)

Initializes an girara session

Parameters:
sessionThe used girara session
appnameName of the session (can be NULL)
Returns:
TRUE No error occured
FALSE An error occured

Definition at line 196 of file session.c.

bool girara_set_view ( girara_session_t *  session,
GtkWidget *  widget 
)

Sets the view widget of girara

Parameters:
sessionThe used girara session
widgetThe widget that should be displayed
Returns:
TRUE No error occured
FALSE An error occured

Definition at line 616 of file session.c.

bool girara_set_window_title ( girara_session_t *  session,
const char *  name 
)

Set name of the window title

Parameters:
sessionThe used girara session
nameThe new name of the session
Returns:
true if no error occured
false if an error occured

Definition at line 683 of file session.c.