Main Page | Directories | File List | File Members
hildon-status-bar

hildon-status-bar-item.h File Reference

#include <gtk/gtkcontainer.h>

Go to the source code of this file.

Defines

#define HILDON_STATUS_BAR_ITEM_TYPE   ( hildon_status_bar_item_get_type() )
#define HILDON_STATUS_BAR_ITEM(obj)
#define HILDON_STATUS_BAR_ITEM_CLASS(klass)
#define HILDON_IS_STATUS_BAR_ITEM(obj)
#define HILDON_IS_STATUS_BAR_ITEM_CLASS(klass)
#define HILDON_STATUS_BAR_ITEM_GET_PRIVATE(obj)

Typedefs

typedef _HildonStatusBarItem HildonStatusBarItem
typedef _HildonStatusBarItemClass HildonStatusBarItemClass
typedef _HildonStatusBarPluginFn_st HildonStatusBarPluginFn_st
typedef void(* HildonStatusBarItemEntryFn )(HildonStatusBarPluginFn_st *fn)
typedef void *(* HildonStatusBarItemInitializeFn )(HildonStatusBarItem *item, GtkWidget **button)
typedef void(* HildonStatusBarItemDestroyFn )(void *data)
typedef void(* HildonStatusBarItemUpdateFn )(void *data, gint value1, gint value2, const gchar *str)
typedef int(* HildonStatusBarItemGetPriorityFn )(void *data)
typedef void(* HildonStatusBarItemSetConditionalFn )(void *data, gboolean cond)

Functions

GType hildon_status_bar_item_get_type (void)
HildonStatusBarItem * hildon_status_bar_item_new (const char *name, gboolean mandatory)
void hildon_status_bar_item_initialize (HildonStatusBarItem *item)
void hildon_status_bar_item_update (HildonStatusBarItem *item, gint value1, gint value2, const gchar *str)
void hildon_status_bar_item_update_conditional_cb (HildonStatusBarItem *item, gboolean user_data)
void hildon_status_bar_item_set_position (HildonStatusBarItem *item, gint position)
gint hildon_status_bar_item_get_position (HildonStatusBarItem *item)
gint hildon_status_bar_item_get_priority (HildonStatusBarItem *item)
const gchar * hildon_status_bar_item_get_name (HildonStatusBarItem *item)
gboolean hildon_status_bar_item_get_conditional (HildonStatusBarItem *item)
gboolean hildon_status_bar_item_get_mandatory (HildonStatusBarItem *item)
void hildon_status_bar_item_set_button (HildonStatusBarItem *item, GtkWidget *button)
GtkWidget * hildon_status_bar_item_get_button (HildonStatusBarItem *item)

Detailed Description

Define Documentation

#define HILDON_IS_STATUS_BAR_ITEM (  obj   ) 
 

Value:

(GTK_CHECK_TYPE (obj, \
            HILDON_STATUS_BAR_ITEM_TYPE))

#define HILDON_IS_STATUS_BAR_ITEM_CLASS (  klass   ) 
 

Value:

(GTK_CHECK_CLASS_TYPE ((klass), \
            HILDON_STATUS_BAR_ITEM_TYPE))

#define HILDON_STATUS_BAR_ITEM (  obj   ) 
 

Value:

(GTK_CHECK_CAST (obj, \
            HILDON_STATUS_BAR_ITEM_TYPE, \
            HildonStatusBarItem))

#define HILDON_STATUS_BAR_ITEM_CLASS (  klass   ) 
 

Value:

(GTK_CHECK_CLASS_CAST ((klass), \
            HILDON_STATUS_BAR_ITEM_TYPE, HildonStatusBarItemClass))

#define HILDON_STATUS_BAR_ITEM_GET_PRIVATE (  obj   ) 
 

Value:

(G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
        HILDON_STATUS_BAR_ITEM_TYPE, HildonStatusBarItemPrivate));

Function Documentation

GtkWidget* hildon_status_bar_item_get_button (  HildonStatusBarItem *  item  ) 
 

Parameters:
*item item to get button from
Returns:
GtkWidget* button of the item
accessor function to get item button

gboolean hildon_status_bar_item_get_conditional (  HildonStatusBarItem *  item  ) 
 

Parameters:
*item item to get conditional from
Returns:
gboolean conditional status of the item
accessor function to get item conditional status

gboolean hildon_status_bar_item_get_mandatory (  HildonStatusBarItem *  item  ) 
 

Parameters:
*item item to get mandatory from
Returns:
gboolean mandatory status of the item
accessor function to get item mandatory status

const gchar* hildon_status_bar_item_get_name (  HildonStatusBarItem *  item  ) 
 

Parameters:
*item item to get the name
Returns:
*gchar name
accessor function to get item name

gint hildon_status_bar_item_get_position (  HildonStatusBarItem *  item  ) 
 

Parameters:
*item the item to update
Returns:
gint position of the item
accessor function to get item position

gint hildon_status_bar_item_get_priority (  HildonStatusBarItem *  item  ) 
 

Parameters:
*item item to get priority from
Returns:
gint priority of the item
accessor function to get item priority

GType hildon_status_bar_item_get_type (  void   ) 
 

This function registers the status bar item type.

void hildon_status_bar_item_initialize (  HildonStatusBarItem *  item  ) 
 

Parameters:
*name item to initialize
Initialize a new statusbar item.

HildonStatusBarItem* hildon_status_bar_item_new (  const char *  name,
gboolean  mandatory
) 
 

Parameters:
*name string naming the plugin
Returns:
HildonStatusBarItem the newly created plugin reference
Creates a new statusbar item.

void hildon_status_bar_item_set_button (  HildonStatusBarItem *  item,
GtkWidget *  button
) 
 

Parameters:
*item item to set button for
accessor function to set item button

void hildon_status_bar_item_set_position (  HildonStatusBarItem *  item,
gint  position
) 
 

Parameters:
*item the item to update
gint position of item
accessor function for setting item position

void hildon_status_bar_item_update (  HildonStatusBarItem *  item,
gint  value1,
gint  value2,
const gchar *  str
) 
 

Parameters:
*item the item to update
value1 parameter to be given to the plugin's own update function
value2 parameter to be given to the plugin's own update function
str parameter to be given to the plugin's own update function
Call's the item's update function and passes on the parameters.

void hildon_status_bar_item_update_conditional_cb (  HildonStatusBarItem *  item,
gboolean  user_data
) 
 

Parameters:
*item the item to update
gboolean user_data parameter to be given to the plugin's own update function
Call's the item's set conditional function and passes on the parameters.

Generated on Thu Dec 21 11:26:53 2006 for maemo-af-desktop-documentation by  doxygen 1.4.2