GnomeDruidPageStandard

## GnomeDruidPageStandard GnomeDruidPageStandard — A widget used to implement the middle pages in a druid's sequence. |

## Synopsis

    #include <libgnomeui/libgnomeui.h>

                GnomeDruidPageStandard;
    #define     gnome_druid_page_standard_set_bg_color
    #define     gnome_druid_page_standard_set_logo_bg_color
    #define     gnome_druid_page_standard_set_title_color
    GtkWidget*  gnome_druid_page_standard_new   (void);
    GtkWidget*  gnome_druid_page_standard_new_with_vals
                                                (const gchar *title,
                                                 GdkPixbuf *logo,
                                                 GdkPixbuf *top_watermark);
    void        gnome_druid_page_standard_set_title
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 const gchar *title);
    void        gnome_druid_page_standard_set_logo
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkPixbuf *logo_image);
    void        gnome_druid_page_standard_set_top_watermark
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkPixbuf *top_watermark_image);
    void        gnome_druid_page_standard_set_title_foreground
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkColor *color);
    void        gnome_druid_page_standard_set_background
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkColor *color);
    void        gnome_druid_page_standard_set_logo_background
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkColor *color);
    void        gnome_druid_page_standard_set_contents_background
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkColor *color);
    void        gnome_druid_page_standard_append_item
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 const gchar *question,
                                                 GtkWidget *item,
                                                 const gchar *additional_info);

## Object Hierarchy

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

## Implemented Interfaces

GnomeDruidPageStandard implements AtkImplementorIface.

## Properties

      "background"           gchararray            : Write
      "background-gdk"       GdkColor              : Read / Write
      "background-set"       gboolean              : Read / Write
      "contents-background"  gchararray            : Write
      "contents-background-gdk" GdkColor              : Read / Write
      "contents-background-set" gboolean              : Read / Write
      "logo"                 GdkPixbuf             : Read / Write
      "logo-background"      gchararray            : Write
      "logo-background-gdk"  GdkColor              : Read / Write
      "logo-background-set"  gboolean              : Read / Write
      "title"                gchararray            : Read / Write
      "title-foreground"     gchararray            : Write
      "title-foreground-gdk" GdkColor              : Read / Write
      "title-foreground-set" gboolean              : Read / Write
      "top-watermark"        GdkPixbuf             : Read / Write

## Description

This widget provides similar functionality to that in GnomeDruidPageEdge. It is used for pages that are not the initial or terminal pages of a druid.

The main difference between an edge and a standard druid page (in a display sense) is that standard pages do not have a left-side watermark and the body of the contents section is a bit more arbitrary (it is a GTK+ vbox widget), rather than just displaying text (which is the common case for edge pages).

### Note

There are some differences in the programming API between GnomeDruidEdgePage and GnomeDruidStandardPage in GNOME 2 because the latter has been heavily redesigned internally, whereas the former has not been. Later versions of GNOME (2.2 and beyond) may contain further refinements to edge pages).

## Details

### GnomeDruidPageStandard

    typedef struct {
    	GtkWidget *vbox;
    	gchar *title;
    	GdkPixbuf *logo;
    	GdkPixbuf *top_watermark;
    	GdkColor title_foreground;
    	GdkColor background;
    	GdkColor logo_background;
    	GdkColor contents_background;
    } GnomeDruidPageStandard;

A widget representing pages that are not initial or terminal pages of a druid.

GtkWidget *`vbox`; | A packing widget that holds the contents of the page.
gchar *`title`; | The title of the displayed page.
GdkPixbuf *`logo`; | The logo of the displayed page.
GdkPixbuf *`top_watermark`; | The watermark at the top of the displated page.
GdkColor `title_foreground`; | The color of the title text.
GdkColor `background`; | The color of the background of the top section and title.
GdkColor `logo_background`; | The background color of the logo.
GdkColor `contents_background`; | The background color of the contents section.

### gnome_druid_page_standard_set_bg_color

    #define     gnome_druid_page_standard_set_bg_color

### Warning

`gnome_druid_page_standard_set_bg_color` is deprecated and should not be used in newly-written code.

This just calls `gnome_druid_page_standard_set_background()` and new code should use that function directly.

### gnome_druid_page_standard_set_logo_bg_color

    #define     gnome_druid_page_standard_set_logo_bg_color

### Warning

`gnome_druid_page_standard_set_logo_bg_color` is deprecated and should not be used in newly-written code.

This just calls `gnome_druid_page_standard_set_logo_background()` and new code should use that function directly.

### gnome_druid_page_standard_set_title_color

    #define     gnome_druid_page_standard_set_title_color

### Warning

`gnome_druid_page_standard_set_title_color` is deprecated and should not be used in newly-written code.

This just calls `gnome_druid_page_standard_set_title_foregournd()` and new code should use that function directly.

### gnome_druid_page_standard_new ()

    GtkWidget*  gnome_druid_page_standard_new   (void);

Construct a new GnomeDruidPageStandard.

Returns : | A new GnomeDruidPageStandard as a GtkWidget pointer.

### gnome_druid_page_standard_new_with_vals ()

    GtkWidget*  gnome_druid_page_standard_new_with_vals
                                                (const gchar *title,
                                                 GdkPixbuf *logo,
                                                 GdkPixbuf *top_watermark);

Like `gnome_druid_page_standard_new()`, but allows the caller to fill in some of the values at the same time.

`title` : | The title of the druid page.
`logo` : | The logo to put on the druid page.
`top_watermark` : | The watermark to put at the top of the druid page.
Returns : | A new GnomeDruidPageStandard as a GtkWidget pointer.

### gnome_druid_page_standard_set_title ()

    void        gnome_druid_page_standard_set_title
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 const gchar *title);

Sets the title to the value of `title`.

`druid_page_standard` : | A GnomeDruidPageStandard instance.
`title` : | The string to use as the new title text.

### gnome_druid_page_standard_set_logo ()

    void        gnome_druid_page_standard_set_logo
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkPixbuf *logo_image);

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

`druid_page_standard` : | A GnomeDruidPageStandard instance.
`logo_image` : | The GdkPixbuf to use as a logo.

### gnome_druid_page_standard_set_top_watermark ()

    void        gnome_druid_page_standard_set_top_watermark
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 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.

`druid_page_standard` : | A GnomeDruidPageStandard instance.
`top_watermark_image` : | The GdkPixbuf to use as a top watermark.

### gnome_druid_page_standard_set_title_foreground ()

    void        gnome_druid_page_standard_set_title_foreground
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkColor *color);

Sets the title text to the specified color.

`druid_page_standard` : | A GnomeDruidPageStandard instance.
`color` : | The new color of the title text.

### gnome_druid_page_standard_set_background ()

    void        gnome_druid_page_standard_set_background
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkColor *color);

Sets the background color of the top section of the druid page to `color`.

`druid_page_standard` : | A GnomeDruidPageStandard instance.
`color` : | The new background color.

### gnome_druid_page_standard_set_logo_background ()

    void        gnome_druid_page_standard_set_logo_background
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkColor *color);

Sets the background of the logo to `color`.

`druid_page_standard` : | A GnomeDruidPageStandard instance.
`color` : | The new color for the logo background.

### gnome_druid_page_standard_set_contents_background ()

    void        gnome_druid_page_standard_set_contents_background
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 GdkColor *color);

Sets the color of the main contents section's background to `color`.

`druid_page_standard` : | A GnomeDruidPageStandard instance.
`color` : | The new color for the main body's background.

### gnome_druid_page_standard_append_item ()

    void        gnome_druid_page_standard_append_item
                                                (GnomeDruidPageStandard *druid_page_standard,
                                                 const gchar *question,
                                                 GtkWidget *item,
                                                 const gchar *additional_info);

Convenience function to add a GtkWidget to the GnomeDruidPageStandard vbox. This function creates a new contents section that has the `question` text followed by the `item` widget and then the `addition_info` text, all stacked vertically from top to bottom.

The `item` widget could be something like a set of radio checkbuttons requesting a choice from the user.

`druid_page_standard` : | A GnomeDruidPageStandard instance.
`question` : | The text to place above the item.
`item` : | The GtkWidget to be included.
`additional_info` : | The text to be placed below the item in a smaller font.

## Properties

### The "`background`" property

      "background"           gchararray            : Write

Background color.

Default value: NULL

### The "`background-gdk`" property

      "background-gdk"       GdkColor              : Read / Write

Background color as a GdkColor.

### The "`background-set`" property

      "background-set"       gboolean              : Read / Write

Background color is set.

Default value: FALSE

### The "`contents-background`" property

      "contents-background"  gchararray            : Write

Contents Background color.

Default value: NULL

### The "`contents-background-gdk`" property

      "contents-background-gdk" GdkColor              : Read / Write

Contents Background color as a GdkColor.

### The "`contents-background-set`" property

      "contents-background-set" gboolean              : Read / Write

Contents Background color is set.

Default value: FALSE

### The "`logo`" property

      "logo"                 GdkPixbuf             : Read / Write

Logo image.

### The "`logo-background`" property

      "logo-background"      gchararray            : Write

Logo Background color.

Default value: NULL

### The "`logo-background-gdk`" property

      "logo-background-gdk"  GdkColor              : Read / Write

Logo Background color as a GdkColor.

### The "`logo-background-set`" property

      "logo-background-set"  gboolean              : Read / Write

Logo Background color is set.

Default value: FALSE

### The "`title`" property

      "title"                gchararray            : Read / Write

Title of the druid.

Default value: NULL

### The "`title-foreground`" property

      "title-foreground"     gchararray            : Write

Foreground color of the title.

Default value: NULL

### The "`title-foreground-gdk`" property

      "title-foreground-gdk" GdkColor              : Read / Write

Foreground color of the title as a GdkColor.

### The "`title-foreground-set`" property

      "title-foreground-set" gboolean              : Read / Write

Foreground color of the title is set.

Default value: FALSE

### The "`top-watermark`" property

      "top-watermark"        GdkPixbuf             : Read / Write

Watermark image for the top.