![]() |
![]() |
![]() |
MATE UI Library Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces |
MateDruidPageEdgeMateDruidPageEdge — A widget used to implement first and last pages in a druid's sequence. |
#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
);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBin +----MateDruidPage +----MateDruidPageEdge
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.
typedef enum { /* update structure when adding enums */ MATE_EDGE_START, MATE_EDGE_FINISH, MATE_EDGE_OTHER, MATE_EDGE_LAST /* for counting purposes */ } MateEdgePosition;
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.
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 MateEdgePosition value. |
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 */ };
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.
The current title of the displayed page. | |
The current text of the displayed page. | |
The logo of the displayed page. | |
The watermark on the left side of the displayed page. | |
The watermark on the top of the displayed page. | |
The color of the edge of the current page (outside the text area). | |
The color of the textbox area of the displayed page. | |
The background color of the displayed page's logo. | |
The color of the title text. | |
The color of the body text. | |
The position of the current page within the druid (a MateEdgePosition value). |
GtkWidget * mate_druid_page_edge_new (MateEdgePosition position
);
mate_druid_page_edge_new
is deprecated and should not be used in newly-written code.
Creates a new MateDruidPageEdge widget.
|
Position in druid. |
Returns : |
GtkWidget pointer to a new MateDruidPageEdge. |
GtkWidget * mate_druid_page_edge_new_aa (MateEdgePosition position
);
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 in druid. |
Returns : |
GtkWidget pointer to a new MateDruidPageEdge. |
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
);
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 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 MateDruidPageEdge. |
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
);
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
.
|
A MateDruidPageEdge 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 mate_druid_page_edge_set_bg_color (MateDruidPageEdge *druid_page_edge
,GdkColor *color
);
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.
|
A MateDruidPageEdge instance.
|
|
The new background color. |
void mate_druid_page_edge_set_textbox_color (MateDruidPageEdge *druid_page_edge
,GdkColor *color
);
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.
|
A MateDruidPageEdge instance.
|
|
The new textbox color. |
void mate_druid_page_edge_set_logo_bg_color (MateDruidPageEdge *druid_page_edge
,GdkColor *color
);
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.
|
A MateDruidPageEdge instance.
|
|
The new color of the logo's background. |
void mate_druid_page_edge_set_title_color (MateDruidPageEdge *druid_page_edge
,GdkColor *color
);
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.
|
A MateDruidPageEdge instance.
|
|
The color of the title text. |
void mate_druid_page_edge_set_text_color (MateDruidPageEdge *druid_page_edge
,GdkColor *color
);
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.
|
A MateDruidPageEdge instance.
|
|
The new test color. |
void mate_druid_page_edge_set_text (MateDruidPageEdge *druid_page_edge
,const gchar *text
);
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.
|
A MateDruidPageEdge instance.
|
|
The text contents. |
void mate_druid_page_edge_set_title (MateDruidPageEdge *druid_page_edge
,const gchar *title
);
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.
|
A MateDruidPageEdge instance.
|
|
The title text |
void mate_druid_page_edge_set_logo (MateDruidPageEdge *druid_page_edge
,GdkPixbuf *logo_image
);
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.
|
A MateDruidPageEdge instance.
|
|
The GdkPixbuf to use as a logo. |
void mate_druid_page_edge_set_watermark (MateDruidPageEdge *druid_page_edge
,GdkPixbuf *watermark
);
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.
|
A MateDruidPageEdge instance.
|
|
The GdkPixbuf to use as a watermark. |
void mate_druid_page_edge_set_top_watermark (MateDruidPageEdge *druid_page_edge
,GdkPixbuf *top_watermark_image
);
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.
|
the MateDruidPageEdge to work on |
|
The GdkPixbuf to use as a top watermark |