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

Go to the source code of this file.

Typedefs

typedef bool(* girara_statusbar_event_t )(GtkWidget *widget, GdkEvent *event, girara_session_t *session)

Functions

girara_statusbar_item_t * girara_statusbar_item_add (girara_session_t *session, bool expand, bool fill, bool left, girara_statusbar_event_t callback)
bool girara_statusbar_item_set_text (girara_session_t *session, girara_statusbar_item_t *item, const char *text)
bool girara_statusbar_item_set_foreground (girara_session_t *session, girara_statusbar_item_t *item, const char *color)
bool girara_statusbar_set_background (girara_session_t *session, const char *color)

Typedef Documentation

typedef bool(* girara_statusbar_event_t)(GtkWidget *widget, GdkEvent *event, girara_session_t *session)

Function declaration for a statusbar event callback

Parameters
widgetThe statusbar item
eventThe occured event
sessionThe current girara session
Returns
TRUE No error occured
FALSE Error occured (and forward event)

Definition at line 18 of file statusbar.h.

Function Documentation

girara_statusbar_item_t* girara_statusbar_item_add ( girara_session_t *  session,
bool  expand,
bool  fill,
bool  left,
girara_statusbar_event_t  callback 
)

Creates an statusbar item

Parameters
sessionThe used girara session
expandExpand attribute
fillFill attribute
leftTrue if it should be aligned to the left
callbackFunction that gets executed when an event occurs
Returns
The created statusbar item
NULL An error occured

Definition at line 21 of file statusbar.c.

bool girara_statusbar_item_set_foreground ( girara_session_t *  session,
girara_statusbar_item_t *  item,
const char *  color 
)

Sets the foreground color of an statusbar item

Parameters
sessionThe used girara session
itemThe statusbar item
colorThe color code
Returns
TRUE No error occured
FALSE An error occured

Definition at line 73 of file statusbar.c.

bool girara_statusbar_item_set_text ( girara_session_t *  session,
girara_statusbar_item_t *  item,
const char *  text 
)

Sets the shown text of an statusbar item

Parameters
sessionThe used girara session
itemThe statusbar item
textText that should be displayed
Returns
TRUE No error occured
FALSE An error occured

Definition at line 60 of file statusbar.c.

bool girara_statusbar_set_background ( girara_session_t *  session,
const char *  color 
)

Sets the background color of the statusbar

Parameters
sessionThe used girara session
colorThe color code
Returns
TRUE No error occured
FALSE An error occured

Definition at line 86 of file statusbar.c.