MateDruidPageEdge

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

Synopsis

#include <libmateui/libmateui.h>

enum                MateEdgePosition;
struct              MateDruidPageEdge;
GtkWidget *         mate_druid_page_edge_new           (MateEdgePosition position);
GtkWidget *         mate_druid_page_edge_new_aa        (MateEdgePosition position);
GtkWidget *         mate_druid_page_edge_new_with_vals (MateEdgePosition position,
                                                         gboolean antialiased,
                                                         const gchar *title,
                                                         const gchar *text,
                                                         GdkPixbuf *logo,
                                                         GdkPixbuf *watermark,
                                                         GdkPixbuf *top_watermark);
void                mate_druid_page_edge_construct     (MateDruidPageEdge *druid_page_edge,
                                                         MateEdgePosition position,
                                                         gboolean antialiased,
                                                         const gchar *title,
                                                         const gchar *text,
                                                         GdkPixbuf *logo,
                                                         GdkPixbuf *watermark,
                                                         GdkPixbuf *top_watermark);
void                mate_druid_page_edge_set_bg_color  (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);
void                mate_druid_page_edge_set_textbox_color
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);
void                mate_druid_page_edge_set_logo_bg_color
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);
void                mate_druid_page_edge_set_title_color
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);
void                mate_druid_page_edge_set_text_color
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);
void                mate_druid_page_edge_set_text      (MateDruidPageEdge *druid_page_edge,
                                                         const gchar *text);
void                mate_druid_page_edge_set_title     (MateDruidPageEdge *druid_page_edge,
                                                         const gchar *title);
void                mate_druid_page_edge_set_logo      (MateDruidPageEdge *druid_page_edge,
                                                         GdkPixbuf *logo_image);
void                mate_druid_page_edge_set_watermark (MateDruidPageEdge *druid_page_edge,
                                                         GdkPixbuf *watermark);
void                mate_druid_page_edge_set_top_watermark
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkPixbuf *top_watermark_image);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----MateDruidPage
                                       +----MateDruidPageEdge

Implemented Interfaces

MateDruidPageEdge implements AtkImplementorIface and GtkBuildable.

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 MateDruidPageEdge widget is for the first and last pages in a druid's sequence of pages. Pages in the "middle" of a sequence should use MateDruidPageStandard.

Details

enum MateEdgePosition

typedef enum {
  /* update structure when adding enums */
	MATE_EDGE_START,
	MATE_EDGE_FINISH,
	MATE_EDGE_OTHER,
	MATE_EDGE_LAST /* for counting purposes */
} MateEdgePosition;

Warning

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

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

`MATE_EDGE_START`	The current page is at the beginning of the druid.
`MATE_EDGE_FINISH`	The current page is at the end of the druid.
`MATE_EDGE_OTHER`	The current page is neither the first nor the last page (usually not required).
`MATE_EDGE_LAST`	Used internally to indicate the last value of the enumeration. This should not be passed in to any function expecting a MateEdgePosition value.

struct MateDruidPageEdge

struct MateDruidPageEdge {
	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; /* MateEdgePosition */
};

Warning

MateDruidPageEdge 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 *`title`;	The current title of the displayed page.
gchar *`text`;	The current text of the displayed page.
GdkPixbuf *`logo_image`;	The logo of the displayed page.
GdkPixbuf *`watermark_image`;	The watermark on the left side of the displayed page.
GdkPixbuf *`top_watermark_image`;	The watermark on the top of the displayed page.
GdkColor `background_color`;	The color of the edge of the current page (outside the text area).
GdkColor `textbox_color`;	The color of the textbox area of the displayed page.
GdkColor `logo_background_color`;	The background color of the displayed page's logo.
GdkColor `title_color`;	The color of the title text.
GdkColor `text_color`;	The color of the body text.
guint `position` : 2;	The position of the current page within the druid (a MateEdgePosition value).

mate_druid_page_edge_new ()

GtkWidget *         mate_druid_page_edge_new           (MateEdgePosition position);

Warning

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

Creates a new MateDruidPageEdge widget.

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

mate_druid_page_edge_new_aa ()

GtkWidget *         mate_druid_page_edge_new_aa        (MateEdgePosition position);

Warning

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

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

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

mate_druid_page_edge_new_with_vals ()

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

Warning

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

This will create a new MATE Druid Edge page, with the values given. It is acceptable for any of them to be NULL. Position should be MATE_EDGE_START, MATE_EDGE_FINISH or MATE_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 MateDruidPageEdge.

mate_druid_page_edge_construct ()

void                mate_druid_page_edge_construct     (MateDruidPageEdge *druid_page_edge,
                                                         MateEdgePosition position,
                                                         gboolean antialiased,
                                                         const gchar *title,
                                                         const gchar *text,
                                                         GdkPixbuf *logo,
                                                         GdkPixbuf *watermark,
                                                         GdkPixbuf *top_watermark);

Warning

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

`druid_page_edge` :	A MateDruidPageEdge instance.
`position` :	The position of `druid_page_edge` within the druid.
`antialiased` :	Unused in the current implementation. Set to `FALSE`.
`title` :	The title of the page.
`text` :	The text in the body of the page.
`logo` :	The logo on the page.
`watermark` :	The watermark on the side of the page.
`top_watermark` :	The watermark on the top of the page.

mate_druid_page_edge_set_bg_color ()

void                mate_druid_page_edge_set_bg_color  (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`color` :	The new background color.

mate_druid_page_edge_set_textbox_color ()

void                mate_druid_page_edge_set_textbox_color
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`color` :	The new textbox color.

mate_druid_page_edge_set_logo_bg_color ()

void                mate_druid_page_edge_set_logo_bg_color
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`color` :	The new color of the logo's background.

mate_druid_page_edge_set_title_color ()

void                mate_druid_page_edge_set_title_color
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`color` :	The color of the title text.

mate_druid_page_edge_set_text_color ()

void                mate_druid_page_edge_set_text_color
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkColor *color);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`color` :	The new test color.

mate_druid_page_edge_set_text ()

void                mate_druid_page_edge_set_text      (MateDruidPageEdge *druid_page_edge,
                                                         const gchar *text);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`text` :	The text contents.

mate_druid_page_edge_set_title ()

void                mate_druid_page_edge_set_title     (MateDruidPageEdge *druid_page_edge,
                                                         const gchar *title);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`title` :	The title text

mate_druid_page_edge_set_logo ()

void                mate_druid_page_edge_set_logo      (MateDruidPageEdge *druid_page_edge,
                                                         GdkPixbuf *logo_image);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`logo_image` :	The GdkPixbuf to use as a logo.

mate_druid_page_edge_set_watermark ()

void                mate_druid_page_edge_set_watermark (MateDruidPageEdge *druid_page_edge,
                                                         GdkPixbuf *watermark);

Warning

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

`druid_page_edge` :	A `MateDruidPageEdge` instance.
`watermark` :	The GdkPixbuf to use as a watermark.

mate_druid_page_edge_set_top_watermark ()

void                mate_druid_page_edge_set_top_watermark
                                                        (MateDruidPageEdge *druid_page_edge,
                                                         GdkPixbuf *top_watermark_image);

Warning

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

`druid_page_edge` :	the MateDruidPageEdge to work on
`top_watermark_image` :	The GdkPixbuf to use as a top watermark

			MATE UI Library Reference Manual
Top \| Description \| Object Hierarchy \| Implemented Interfaces