ESplash

ESplash —

Synopsis




            ESplash;
void        e_splash_construct              (ESplash *splash,
                                             GdkPixbuf *splash_image_pixbuf,
                                             gint progressbar_position);
GtkWidget*  e_splash_new                    (const char *image_file,
                                             gint progressbar_position);
int         e_splash_add_icon               (ESplash *splash,
                                             GdkPixbuf *icon_pixbuf,
                                             const gchar *title,
                                             const gchar *desc);
void        e_splash_set_icon_highlight     (ESplash *splash,
                                             int num,
                                             gboolean highlight);


Description

Details

ESplash

typedef struct {
	GtkWindow parent;

	ESplashPrivate *priv;
} ESplash;


e_splash_construct ()

void        e_splash_construct              (ESplash *splash,
                                             GdkPixbuf *splash_image_pixbuf,
                                             gint progressbar_position);

Construct splash with splash_image_pixbuf as the splash image.

splash : A pointer to an ESplash widget
splash_image_pixbuf : The pixbuf for the image to appear in the splash dialog
progressbar_position :

e_splash_new ()

GtkWidget*  e_splash_new                    (const char *image_file,
                                             gint progressbar_position);

Create a new ESplash widget.

image_file : Splash image file
progressbar_position :
Returns : A pointer to the newly created ESplash widget.

e_splash_add_icon ()

int         e_splash_add_icon               (ESplash *splash,
                                             GdkPixbuf *icon_pixbuf,
                                             const gchar *title,
                                             const gchar *desc);

Add icon_pixbuf to the splash.

splash : A pointer to an ESplash widget
icon_pixbuf : Pixbuf for the icon to be added
title : Title.
desc : Description.
Returns : The total number of icons in the splash after the new icon has been added.

e_splash_set_icon_highlight ()

void        e_splash_set_icon_highlight     (ESplash *splash,
                                             int num,
                                             gboolean highlight);

Change the highlight state of the num-th icon.

splash : A pointer to an ESplash widget
num : Number of the icon whose highlight state must be changed
highlight : Whether the icon must be highlit or not