hildon-status-bar-item.h

Go to the documentation of this file.

/*
 * This file is part of maemo-af-desktop
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Karoliina Salminen <karoliina.t.salminen@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef HILDON_STATUS_BAR_ITEM_H
#define HILDON_STATUS_BAR_ITEM_H

#include <gtk/gtkcontainer.h>

G_BEGIN_DECLS

#define HILDON_STATUS_BAR_ITEM_TYPE ( hildon_status_bar_item_get_type() )
#define HILDON_STATUS_BAR_ITEM(obj) (GTK_CHECK_CAST (obj, \
            HILDON_STATUS_BAR_ITEM_TYPE, \
            HildonStatusBarItem))
#define HILDON_STATUS_BAR_ITEM_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), \
            HILDON_STATUS_BAR_ITEM_TYPE, HildonStatusBarItemClass))
#define HILDON_IS_STATUS_BAR_ITEM(obj) (GTK_CHECK_TYPE (obj, \
            HILDON_STATUS_BAR_ITEM_TYPE))
#define HILDON_IS_STATUS_BAR_ITEM_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), \
            HILDON_STATUS_BAR_ITEM_TYPE))
#define HILDON_STATUS_BAR_ITEM_GET_PRIVATE(obj) \
        (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
        HILDON_STATUS_BAR_ITEM_TYPE, HildonStatusBarItemPrivate));

typedef struct _HildonStatusBarItem HildonStatusBarItem; 
typedef struct _HildonStatusBarItemClass HildonStatusBarItemClass;
typedef struct _HildonStatusBarPluginFn_st HildonStatusBarPluginFn_st; 

struct _HildonStatusBarItem
{
    GtkContainer parent;
};

struct _HildonStatusBarItemClass
{
    GtkContainerClass parent_class;
    void (*hildon_status_bar_update_conditional) 
        (HildonStatusBarItem * self, gboolean conditional_status);

    void (*hildon_status_bar_log_start) (HildonStatusBarItem * self);
    void (*hildon_status_bar_log_end)   (HildonStatusBarItem * self);
};

/* Type definitions for the plugin API */ 
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 );


/* Struct for the plugin API function pointers */
struct _HildonStatusBarPluginFn_st 
{
    HildonStatusBarItemInitializeFn     initialize;
    HildonStatusBarItemDestroyFn        destroy;
    HildonStatusBarItemUpdateFn         update;
    HildonStatusBarItemGetPriorityFn    get_priority;
    HildonStatusBarItemSetConditionalFn set_conditional;
};

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 );


G_END_DECLS

#endif /* HILDON_STATUS_BAR_ITEM_H */

---