GNOME UI Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GnomeDruidPageEdge

## Name

GnomeDruidPageEdge --

## Synopsis

    enum        GnomeEdgePosition;
    struct      GnomeDruidPageEdgePrivate;
    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_construct (GnomeDruidPageEdge *druid_page_edge,
                                                 GnomeEdgePosition position,
                                                 gboolean antialiaed,
                                                 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);

## Description

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

### struct GnomeDruidPageEdgePrivate

    struct GnomeDruidPageEdgePrivate;

### gnome_druid_page_edge_new ()

    GtkWidget*  gnome_druid_page_edge_new       (GnomeEdgePosition position);

Creates a new GnomeDruidPageEdge widget.

`position` : | Position in druid
Returns : | GtkWidget pointer to a new GnomeDruidPageEdge.

### 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.

`position` : | Position in druid
Returns : | GtkWidget pointer to a new GnomeDruidPageEdge.

### 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`.

`position` : | Position in druid
`antialiased` : | Use an antialiased canvas
`title` : | The title.
`text` : | The introduction text.
`logo` : | The logo in the upper right corner.
`watermark` : | The watermark on the left.
`top_watermark` : | The watermark on the left.
Returns : | GtkWidget pointer to a new GnomeDruidPageEdge.

### gnome_druid_page_edge_construct ()

    void        gnome_druid_page_edge_construct (GnomeDruidPageEdge *druid_page_edge,
                                                 GnomeEdgePosition position,
                                                 gboolean antialiaed,
                                                 const gchar *title,
                                                 const gchar *text,
                                                 GdkPixbuf *logo,
                                                 GdkPixbuf *watermark,
                                                 GdkPixbuf *top_watermark);

Useful for subclassing and binding only

`druid_page_edge` : |
`position` : |
`antialiaed` : |
`title` : |
`text` : |
`logo` : |
`watermark` : |
`top_watermark` : |

### 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.

`druid_page_edge` : | A DruidPageEdge.
`color` : | The new background color.

### gnome_druid_page_edge_set_textbox_color ()

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

`druid_page_edge` : |
`color` : |

### gnome_druid_page_edge_set_logo_bg_color ()

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

`druid_page_edge` : |
`color` : |

### gnome_druid_page_edge_set_title_color ()

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

`druid_page_edge` : |
`color` : |

### gnome_druid_page_edge_set_text_color ()

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

`druid_page_edge` : |
`color` : |

### gnome_druid_page_edge_set_text ()

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

`druid_page_edge` : |
`text` : |

### gnome_druid_page_edge_set_title ()

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

`druid_page_edge` : |
`title` : |

### 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.

`druid_page_edge` : | the GnomeDruidPageEdge to work on
`logo_image` : | The GdkPixbuf to use as a logo

### 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 top_watermark_image is `NULL`, it is reset to the normal color.

`druid_page_edge` : | the GnomeDruidPageEdge to work on
`watermark` : |

### gnome_druid_page_edge_set_top_watermark ()

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

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.

`druid_page_edge` : | the GnomeDruidPageEdge to work on
`top_watermark` : |

<<< Previous Page | Home | Up | Next Page >>>
GnomeDateEdit | GnomeFileEntry