GnomeDruidPageEdge

Name

GnomeDruidPageEdge -- A widget used to implement first and last pages in a druid's sequence.

Synopsis


#include <libgnomeui/libgnomeui.h>


enum        GnomeEdgePosition;
struct      GnomeDruidPageEdge;
GtkWidget*  gnome_druid_page_edge_new       (GnomeEdgePosition position);
GtkWidget*  gnome_druid_page_edge_new_aa    (GnomeEdgePosition position);
GtkWidget*  gnome_druid_page_edge_new_with_vals
                                            (GnomeEdgePosition position,
                                             gboolean antialiased,
                                             const gchar *title,
                                             const gchar *text,
                                             GdkPixbuf *logo,
                                             GdkPixbuf *watermark,
                                             GdkPixbuf *top_watermark);
void        gnome_druid_page_edge_set_bg_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);
void        gnome_druid_page_edge_set_textbox_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);
void        gnome_druid_page_edge_set_logo_bg_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);
void        gnome_druid_page_edge_set_title_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);
void        gnome_druid_page_edge_set_text_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);
void        gnome_druid_page_edge_set_text  (GnomeDruidPageEdge *druid_page_edge,
                                             const gchar *text);
void        gnome_druid_page_edge_set_title (GnomeDruidPageEdge *druid_page_edge,
                                             const gchar *title);
void        gnome_druid_page_edge_set_logo  (GnomeDruidPageEdge *druid_page_edge,
                                             GdkPixbuf *logo_image);
void        gnome_druid_page_edge_set_watermark
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkPixbuf *watermark);
void        gnome_druid_page_edge_set_top_watermark
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkPixbuf *top_watermark_image);


Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GnomeDruidPage
                                 +----GnomeDruidPageEdge

Description

A druid can be thought of as having a page that starts the sequence, one or more pages that end the sequences (there can be multiple end pages if the flow of pages diverges at some point) and some pages that are in between the start and end pages.

The GnomeDruidPageEdge widget is for the first and last pages in a druid's sequence of pages. Pages in the "middle" of a sequence should use GnomeDruidPageStandard.

Details

enum GnomeEdgePosition

typedef enum {
  /* update structure when adding enums */
	GNOME_EDGE_START,
	GNOME_EDGE_FINISH,
	GNOME_EDGE_OTHER,
	GNOME_EDGE_LAST /* for counting purposes */
} GnomeEdgePosition;

Used to pass around information about the position of a GnomeDruidPage within the overall GnomeDruid. This enables the correct "surrounding" content for the page to be drawn.


struct GnomeDruidPageEdge

struct GnomeDruidPageEdge {
	gchar *title;
	gchar *text;
	GdkPixbuf *logo_image;
	GdkPixbuf *watermark_image;
	GdkPixbuf *top_watermark_image;

	GdkColor background_color;
	GdkColor textbox_color;
	GdkColor logo_background_color;
	GdkColor title_color;
	GdkColor text_color;

	GnomeEdgePosition position : 2;

};

A widget holding information about the overall look of the currently displaying druid page.


gnome_druid_page_edge_new ()

GtkWidget*  gnome_druid_page_edge_new       (GnomeEdgePosition position);

Creates a new GnomeDruidPageEdge widget.


gnome_druid_page_edge_new_aa ()

GtkWidget*  gnome_druid_page_edge_new_aa    (GnomeEdgePosition position);

Creates a new GnomeDruidPageEdge widget. The internal canvas is created in an antialiased mode.


gnome_druid_page_edge_new_with_vals ()

GtkWidget*  gnome_druid_page_edge_new_with_vals
                                            (GnomeEdgePosition position,
                                             gboolean antialiased,
                                             const gchar *title,
                                             const gchar *text,
                                             GdkPixbuf *logo,
                                             GdkPixbuf *watermark,
                                             GdkPixbuf *top_watermark);

This will create a new GNOME Druid Edge page, with the values given. It is acceptable for any of them to be NULL. Position should be GNOME_EDGE_START, GNOME_EDGE_FINISH or GNOME_EDGE_OTHER.


gnome_druid_page_edge_set_bg_color ()

void        gnome_druid_page_edge_set_bg_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);

This will set the background color to be the color. You do not need to allocate the color, as the druid_page_edge will do it for you.


gnome_druid_page_edge_set_textbox_color ()

void        gnome_druid_page_edge_set_textbox_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);

Sets the color of the background in the main text area of the page.


gnome_druid_page_edge_set_logo_bg_color ()

void        gnome_druid_page_edge_set_logo_bg_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);

Set the color behind the druid page's logo.


gnome_druid_page_edge_set_title_color ()

void        gnome_druid_page_edge_set_title_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);

Sets the color of the title text on the current page.


gnome_druid_page_edge_set_text_color ()

void        gnome_druid_page_edge_set_text_color
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkColor *color);

Sets the color of the text in the body of the druid page.


gnome_druid_page_edge_set_text ()

void        gnome_druid_page_edge_set_text  (GnomeDruidPageEdge *druid_page_edge,
                                             const gchar *text);

Sets the contents of the text portion of the druid page.


gnome_druid_page_edge_set_title ()

void        gnome_druid_page_edge_set_title (GnomeDruidPageEdge *druid_page_edge,
                                             const gchar *title);

Sets the contents of the page's title text.


gnome_druid_page_edge_set_logo ()

void        gnome_druid_page_edge_set_logo  (GnomeDruidPageEdge *druid_page_edge,
                                             GdkPixbuf *logo_image);

Sets a GdkPixbuf as the logo in the top right corner. If NULL, then no logo will be displayed.


gnome_druid_page_edge_set_watermark ()

void        gnome_druid_page_edge_set_watermark
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkPixbuf *watermark);

Sets a GdkPixbuf as the watermark on the left strip on the druid. If watermark is NULL, it is reset to the normal color.


gnome_druid_page_edge_set_top_watermark ()

void        gnome_druid_page_edge_set_top_watermark
                                            (GnomeDruidPageEdge *druid_page_edge,
                                             GdkPixbuf *top_watermark_image);

Sets a GdkPixbuf as the watermark on top of the top strip on the druid. If top_watermark_image is NULL, it is reset to the normal color.