| GNOME UI Library Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | ||||
#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_construct (GnomeDruidPageEdge *druid_page_edge,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);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBin +----GnomeDruidPage +----GnomeDruidPageEdge
typedef enum {
/* update structure when adding enums */
GNOME_EDGE_START,
GNOME_EDGE_FINISH,
GNOME_EDGE_OTHER,
GNOME_EDGE_LAST /* for counting purposes */
} GnomeEdgePosition;
GnomeEdgePosition is deprecated and should not be used in newly-written code.
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.
| The current page is at the beginning of the druid. | |
| The current page is at the end of the druid. | |
| The current page is neither the first nor the last page (usually not required). | |
| Used internally to indicate the last value of the enumeration. This should not be passed in to any function expecting a GnomeEdgePosition value. |
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;
guint position : 2; /* GnomeEdgePosition */
};
GnomeDruidPageEdge is deprecated and should not be used in newly-written code.
A widget holding information about the overall look of the currently displaying druid page.
gchar * |
The current title of the displayed page. |
gchar * |
The current text of the displayed page. |
GdkPixbuf * |
The logo of the displayed page. |
GdkPixbuf * |
The watermark on the left side of the displayed page. |
GdkPixbuf * |
The watermark on the top of the displayed page. |
GdkColor |
The color of the edge of the current page (outside the text area). |
GdkColor |
The color of the textbox area of the displayed page. |
GdkColor |
The background color of the displayed page's logo. |
GdkColor |
The color of the title text. |
GdkColor |
The color of the body text. |
guint |
The position of the current page within the druid (a GnomeEdgePosition value). |
GtkWidget * gnome_druid_page_edge_new (GnomeEdgePosition position);
gnome_druid_page_edge_new is deprecated and should not be used in newly-written code.
Creates a new GnomeDruidPageEdge widget.
|
Position in druid. |
Returns : |
GtkWidget pointer to a new GnomeDruidPageEdge. |
GtkWidget * gnome_druid_page_edge_new_aa (GnomeEdgePosition position);
gnome_druid_page_edge_new_aa is deprecated and should not be used in newly-written code.
Creates a new GnomeDruidPageEdge widget. The internal canvas is created in an antialiased mode.
|
Position in druid. |
Returns : |
GtkWidget pointer to a new GnomeDruidPageEdge. |
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);
gnome_druid_page_edge_new_with_vals is deprecated and should not be used in newly-written code.
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 in druid. |
|
Use an antialiased canvas |
|
The title. |
|
The introduction text. |
|
The logo in the upper right corner. |
|
The watermark on the left. |
|
The watermark on the left. |
Returns : |
GtkWidget pointer to a new GnomeDruidPageEdge. |
void gnome_druid_page_edge_construct (GnomeDruidPageEdge *druid_page_edge,GnomeEdgePosition position,gboolean antialiased,const gchar *title,const gchar *text,GdkPixbuf *logo,GdkPixbuf *watermark,GdkPixbuf *top_watermark);
gnome_druid_page_edge_construct is deprecated and should not be used in newly-written code.
Useful for subclassing and language bindings, this function
fills the given pieces of information into the existing druid_page_edge.
|
A GnomeDruidPageEdge instance. |
|
The position of druid_page_edge within the druid. |
|
Unused in the current implementation. Set to FALSE. |
|
The title of the page. |
|
The text in the body of the page. |
|
The logo on the page. |
|
The watermark on the side of the page. |
|
The watermark on the top of the page. |
void gnome_druid_page_edge_set_bg_color (GnomeDruidPageEdge *druid_page_edge,GdkColor *color);
gnome_druid_page_edge_set_bg_color is deprecated and should not be used in newly-written code.
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.
|
A GnomeDruidPageEdge instance. |
|
The new background color. |
void gnome_druid_page_edge_set_textbox_color (GnomeDruidPageEdge *druid_page_edge,GdkColor *color);
gnome_druid_page_edge_set_textbox_color is deprecated and should not be used in newly-written code.
Sets the color of the background in the main text area of the page.
|
A GnomeDruidPageEdge instance. |
|
The new textbox color. |
void gnome_druid_page_edge_set_logo_bg_color (GnomeDruidPageEdge *druid_page_edge,GdkColor *color);
gnome_druid_page_edge_set_logo_bg_color is deprecated and should not be used in newly-written code.
Set the color behind the druid page's logo.
|
A GnomeDruidPageEdge instance. |
|
The new color of the logo's background. |
void gnome_druid_page_edge_set_title_color (GnomeDruidPageEdge *druid_page_edge,GdkColor *color);
gnome_druid_page_edge_set_title_color is deprecated and should not be used in newly-written code.
Sets the color of the title text on the current page.
|
A GnomeDruidPageEdge instance. |
|
The color of the title text. |
void gnome_druid_page_edge_set_text_color (GnomeDruidPageEdge *druid_page_edge,GdkColor *color);
gnome_druid_page_edge_set_text_color is deprecated and should not be used in newly-written code.
Sets the color of the text in the body of the druid page.
|
A GnomeDruidPageEdge instance. |
|
The new test color. |
void gnome_druid_page_edge_set_text (GnomeDruidPageEdge *druid_page_edge,const gchar *text);
gnome_druid_page_edge_set_text is deprecated and should not be used in newly-written code.
Sets the contents of the text portion of the druid page.
|
A GnomeDruidPageEdge instance. |
|
The text contents. |
void gnome_druid_page_edge_set_title (GnomeDruidPageEdge *druid_page_edge,const gchar *title);
gnome_druid_page_edge_set_title is deprecated and should not be used in newly-written code.
Sets the contents of the page's title text.
|
A GnomeDruidPageEdge instance. |
|
The title text |
void gnome_druid_page_edge_set_logo (GnomeDruidPageEdge *druid_page_edge,GdkPixbuf *logo_image);
gnome_druid_page_edge_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.
|
A GnomeDruidPageEdge instance. |
|
The GdkPixbuf to use as a logo. |
void gnome_druid_page_edge_set_watermark (GnomeDruidPageEdge *druid_page_edge,GdkPixbuf *watermark);
gnome_druid_page_edge_set_watermark is deprecated and should not be used in newly-written code.
Sets a GdkPixbuf as the watermark on the left strip on the
druid. If watermark is NULL, it is reset to the normal color.
|
A GnomeDruidPageEdge instance. |
|
The GdkPixbuf to use as a watermark. |
void gnome_druid_page_edge_set_top_watermark (GnomeDruidPageEdge *druid_page_edge,GdkPixbuf *top_watermark_image);
gnome_druid_page_edge_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.
|
the GnomeDruidPageEdge to work on |
|
The GdkPixbuf to use as a top watermark |