GnomeDruidPageStandard: GNOME UI Library Reference Manual

GnomeDruidPageStandard

Functions

GtkWidget *	gnome_druid_page_standard_new ()
GtkWidget *	gnome_druid_page_standard_new_with_vals ()
void	gnome_druid_page_standard_set_title ()
void	gnome_druid_page_standard_set_logo ()
void	gnome_druid_page_standard_set_top_watermark ()
void	gnome_druid_page_standard_set_title_foreground ()
void	gnome_druid_page_standard_set_background ()
void	gnome_druid_page_standard_set_logo_background ()
void	gnome_druid_page_standard_set_contents_background ()
void	gnome_druid_page_standard_append_item ()

Properties

char *	background	Write
GdkColor *	background-gdk	Read / Write
gboolean	background-set	Read / Write
char *	contents-background	Write
GdkColor *	contents-background-gdk	Read / Write
gboolean	contents-background-set	Read / Write
GdkPixbuf *	logo	Read / Write
char *	logo-background	Write
GdkColor *	logo-background-gdk	Read / Write
gboolean	logo-background-set	Read / Write
char *	title	Read / Write
char *	title-foreground	Write
GdkColor *	title-foreground-gdk	Read / Write
gboolean	title-foreground-set	Read / Write
GdkPixbuf *	top-watermark	Read / Write

Types and Values

struct	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

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBin
                        ╰── GnomeDruidPage
                            ╰── GnomeDruidPageStandard

Implemented Interfaces

GnomeDruidPageStandard implements AtkImplementorIface and GtkBuildable.

Includes

#include <libgnomeui/libgnomeui.h>

Description

Functions

gnome_druid_page_standard_new ()

GtkWidget *
gnome_druid_page_standard_new (void);

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

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

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

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

Parameters

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

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

Sets the title to the value of title .

Parameters

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

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

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

Parameters

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

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

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.

Parameters

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

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

Sets the title text to the specified color.

Parameters

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

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

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

Parameters

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

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

Sets the background of the logo to color .

Parameters

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

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

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

Parameters

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

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

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.

Parameters

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.

Types and Values

struct GnomeDruidPageStandard

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

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

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

Members

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

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

gnome_druid_page_standard_set_logo_bg_color

#define             gnome_druid_page_standard_set_logo_bg_color

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

gnome_druid_page_standard_set_title_color

#define             gnome_druid_page_standard_set_title_color

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

Property Details

The `“background”` property

  “background”               char *

Background color.

Owner: GnomeDruidPageStandard

Flags: Write

Default value: NULL

The `“background-gdk”` property

  “background-gdk”           GdkColor *

Background color as a GdkColor.

Owner: GnomeDruidPageStandard

Flags: Read / Write

The `“background-set”` property

  “background-set”           gboolean

Background color is set.

Owner: GnomeDruidPageStandard

Flags: Read / Write

Default value: FALSE

The `“contents-background”` property

  “contents-background”      char *

Contents Background color.

Owner: GnomeDruidPageStandard

Flags: Write

Default value: NULL

The `“contents-background-gdk”` property

  “contents-background-gdk”  GdkColor *

Contents Background color as a GdkColor.

Owner: GnomeDruidPageStandard

Flags: Read / Write

The `“contents-background-set”` property

  “contents-background-set”  gboolean

Contents Background color is set.

Owner: GnomeDruidPageStandard

Flags: Read / Write

Default value: FALSE

The `“logo”` property

  “logo”                     GdkPixbuf *

Logo image.

Owner: GnomeDruidPageStandard

Flags: Read / Write

The `“logo-background”` property

  “logo-background”          char *

Logo Background color.

Owner: GnomeDruidPageStandard

Flags: Write

Default value: NULL

The `“logo-background-gdk”` property

  “logo-background-gdk”      GdkColor *

Logo Background color as a GdkColor.

Owner: GnomeDruidPageStandard

Flags: Read / Write

The `“logo-background-set”` property

  “logo-background-set”      gboolean

Logo Background color is set.

Owner: GnomeDruidPageStandard

Flags: Read / Write

Default value: FALSE

The `“title”` property

  “title”                    char *

Title of the druid.

Owner: GnomeDruidPageStandard

Flags: Read / Write

Default value: NULL

The `“title-foreground”` property

  “title-foreground”         char *

Foreground color of the title.

Owner: GnomeDruidPageStandard

Flags: Write

Default value: NULL

The `“title-foreground-gdk”` property

  “title-foreground-gdk”     GdkColor *

Foreground color of the title as a GdkColor.

Owner: GnomeDruidPageStandard

Flags: Read / Write

The `“title-foreground-set”` property

  “title-foreground-set”     gboolean

Foreground color of the title is set.

Owner: GnomeDruidPageStandard

Flags: Read / Write

Default value: FALSE

The `“top-watermark”` property

  “top-watermark”            GdkPixbuf *

Watermark image for the top.

Owner: GnomeDruidPageStandard

Flags: Read / Write