![]() |
![]() |
![]() |
plank Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#define PLANK_DRAWING_TYPE_THEME void plank_drawing_theme_load (PlankDrawingTheme *self
,const gchar *type
); gint plank_drawing_theme_get_top_offset (PlankDrawingTheme *self
); gint plank_drawing_theme_get_bottom_offset (PlankDrawingTheme *self
); void plank_drawing_theme_draw_background (PlankDrawingTheme *self
,PlankDrawingDockSurface *surface
); void plank_drawing_theme_draw_inner_rect (PlankDrawingTheme *self
,cairo_t *cr
,gint width
,gint height
); #define PLANK_DRAWING_THEME_DEFAULT_NAME gint plank_drawing_theme_get_TopRoundness (PlankDrawingTheme *self
); void plank_drawing_theme_set_TopRoundness (PlankDrawingTheme *self
,gint value
); gint plank_drawing_theme_get_BottomRoundness (PlankDrawingTheme *self
); void plank_drawing_theme_set_BottomRoundness (PlankDrawingTheme *self
,gint value
); gint plank_drawing_theme_get_LineWidth (PlankDrawingTheme *self
); void plank_drawing_theme_set_LineWidth (PlankDrawingTheme *self
,gint value
); void plank_drawing_theme_get_OuterStrokeColor (PlankDrawingTheme *self
,PlankDrawingColor *result
); void plank_drawing_theme_set_OuterStrokeColor (PlankDrawingTheme *self
,PlankDrawingColor *value
); void plank_drawing_theme_get_FillStartColor (PlankDrawingTheme *self
,PlankDrawingColor *result
); void plank_drawing_theme_set_FillStartColor (PlankDrawingTheme *self
,PlankDrawingColor *value
); void plank_drawing_theme_get_FillEndColor (PlankDrawingTheme *self
,PlankDrawingColor *result
); void plank_drawing_theme_set_FillEndColor (PlankDrawingTheme *self
,PlankDrawingColor *value
); void plank_drawing_theme_get_InnerStrokeColor (PlankDrawingTheme *self
,PlankDrawingColor *result
); void plank_drawing_theme_set_InnerStrokeColor (PlankDrawingTheme *self
,PlankDrawingColor *value
); void plank_drawing_theme_draw_rounded_rect (cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
,gdouble top_radius
,gdouble bottom_radius
,gdouble line_width
); void plank_drawing_theme_draw_rounded_line (cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
,gboolean is_round_left
,gboolean is_round_right
,cairo_pattern_t *stroke
,cairo_pattern_t *fill
); GeeArrayList * plank_drawing_theme_get_theme_list (void
); GFile * plank_drawing_theme_get_theme_folder (const gchar *name
); struct PlankDrawingTheme; struct PlankDrawingThemeClass;
GObject +----PlankServicesPreferences +----PlankDrawingTheme +----PlankDrawingDockTheme +----PlankDrawingHoverTheme
"BottomRoundness" gint : Read / Write "FillEndColor" PlankDrawingColor* : Read / Write "FillStartColor" PlankDrawingColor* : Read / Write "InnerStrokeColor" PlankDrawingColor* : Read / Write "LineWidth" gint : Read / Write "OuterStrokeColor" PlankDrawingColor* : Read / Write "TopRoundness" gint : Read / Write
#define PLANK_DRAWING_TYPE_THEME (plank_drawing_theme_get_type ())
The type for PlankDrawingTheme.
void plank_drawing_theme_load (PlankDrawingTheme *self
,const gchar *type
);
Loads a theme for the renderer to use.
|
the PlankDrawingTheme instance |
|
. the type of theme to load. [in] |
gint plank_drawing_theme_get_top_offset (PlankDrawingTheme *self
);
Returns the top offset.
|
the PlankDrawingTheme instance |
Returns : |
the top offset |
gint plank_drawing_theme_get_bottom_offset
(PlankDrawingTheme *self
);
Returns the bottom offset.
|
the PlankDrawingTheme instance |
Returns : |
the bottom offset |
void plank_drawing_theme_draw_background (PlankDrawingTheme *self
,PlankDrawingDockSurface *surface
);
Draws a background onto the surface.
|
the PlankDrawingTheme instance |
|
. the dock surface to draw on. [in] |
void plank_drawing_theme_draw_inner_rect (PlankDrawingTheme *self
,cairo_t *cr
,gint width
,gint height
);
Similar to draw_rounded_rect, but moves in to avoid a containing rounded rect's lines.
|
the PlankDrawingTheme instance |
|
. the context to draw with. [in] |
|
. the width of the rect. [in] |
|
. the height of the rect. [in] |
gint plank_drawing_theme_get_TopRoundness
(PlankDrawingTheme *self
);
Get and return the current value of the "top-roundness" property.
|
the PlankDrawingTheme instance to query |
Returns : |
the value of the "top-roundness" property |
void plank_drawing_theme_set_TopRoundness (PlankDrawingTheme *self
,gint value
);
Set the value of the "top-roundness" property to value
.
|
the PlankDrawingTheme instance to modify |
|
the new value of the "top-roundness" property |
gint plank_drawing_theme_get_BottomRoundness
(PlankDrawingTheme *self
);
Get and return the current value of the "bottom-roundness" property.
|
the PlankDrawingTheme instance to query |
Returns : |
the value of the "bottom-roundness" property |
void plank_drawing_theme_set_BottomRoundness (PlankDrawingTheme *self
,gint value
);
Set the value of the "bottom-roundness" property to value
.
|
the PlankDrawingTheme instance to modify |
|
the new value of the "bottom-roundness" property |
gint plank_drawing_theme_get_LineWidth (PlankDrawingTheme *self
);
Get and return the current value of the "line-width" property.
|
the PlankDrawingTheme instance to query |
Returns : |
the value of the "line-width" property |
void plank_drawing_theme_set_LineWidth (PlankDrawingTheme *self
,gint value
);
Set the value of the "line-width" property to value
.
|
the PlankDrawingTheme instance to modify |
|
the new value of the "line-width" property |
void plank_drawing_theme_get_OuterStrokeColor (PlankDrawingTheme *self
,PlankDrawingColor *result
);
Get and return the current value of the "outer-stroke-color" property.
|
the PlankDrawingTheme instance to query |
Returns : |
the value of the "outer-stroke-color" property |
void plank_drawing_theme_set_OuterStrokeColor (PlankDrawingTheme *self
,PlankDrawingColor *value
);
Set the value of the "outer-stroke-color" property to value
.
|
the PlankDrawingTheme instance to modify |
|
the new value of the "outer-stroke-color" property |
void plank_drawing_theme_get_FillStartColor (PlankDrawingTheme *self
,PlankDrawingColor *result
);
Get and return the current value of the "fill-start-color" property.
|
the PlankDrawingTheme instance to query |
Returns : |
the value of the "fill-start-color" property |
void plank_drawing_theme_set_FillStartColor (PlankDrawingTheme *self
,PlankDrawingColor *value
);
Set the value of the "fill-start-color" property to value
.
|
the PlankDrawingTheme instance to modify |
|
the new value of the "fill-start-color" property |
void plank_drawing_theme_get_FillEndColor (PlankDrawingTheme *self
,PlankDrawingColor *result
);
Get and return the current value of the "fill-end-color" property.
|
the PlankDrawingTheme instance to query |
Returns : |
the value of the "fill-end-color" property |
void plank_drawing_theme_set_FillEndColor (PlankDrawingTheme *self
,PlankDrawingColor *value
);
Set the value of the "fill-end-color" property to value
.
|
the PlankDrawingTheme instance to modify |
|
the new value of the "fill-end-color" property |
void plank_drawing_theme_get_InnerStrokeColor (PlankDrawingTheme *self
,PlankDrawingColor *result
);
Get and return the current value of the "inner-stroke-color" property.
|
the PlankDrawingTheme instance to query |
Returns : |
the value of the "inner-stroke-color" property |
void plank_drawing_theme_set_InnerStrokeColor (PlankDrawingTheme *self
,PlankDrawingColor *value
);
Set the value of the "inner-stroke-color" property to value
.
|
the PlankDrawingTheme instance to modify |
|
the new value of the "inner-stroke-color" property |
void plank_drawing_theme_draw_rounded_rect (cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
,gdouble top_radius
,gdouble bottom_radius
,gdouble line_width
);
Draws a rounded rectangle. If compositing is disabled, just draws a normal rectangle.
|
. the context to draw with. [in] |
|
. the x location of the rect. [in] |
|
. the y location of the rect. [in] |
|
. the width of the rect. [in] |
|
. the height of the rect. [in] |
|
. the roundedness of the top edge. [in] |
|
. the roundedness of the bottom edge. [in] |
|
. the line-width of the rect. [in] |
void plank_drawing_theme_draw_rounded_line (cairo_t *cr
,gdouble x
,gdouble y
,gdouble width
,gdouble height
,gboolean is_round_left
,gboolean is_round_right
,cairo_pattern_t *stroke
,cairo_pattern_t *fill
);
Draws a rounded horizontal line.
|
. the context to draw with. [in] |
|
. the x location of the line. [in] |
|
. the y location of the line. [in] |
|
. the width of the line. [in] |
|
. the height of the line. [in] |
|
. weather the left is round or not. [in] |
|
. weather the right is round or not. [in] |
|
. filling style of the outline. [in][allow-none] |
|
. filling style of the inner area. [in][allow-none] |
GeeArrayList * plank_drawing_theme_get_theme_list (void
);
Get a sorted list of all available theme-names
Returns : |
GeeArrayList the list of theme-names |
GFile * plank_drawing_theme_get_theme_folder
(const gchar *name
);
Try to get an already existing folder located in the themes folder while prefering the user's themes folder. If there is no folder found we fallback to the "Default" theme. If even that folder doesn't exist return NULL (and use built-in defaults)
|
. the basename of the folder. [in] |
Returns : |
GFile the folder of the theme or NULL |
struct PlankDrawingThemeClass { PlankServicesPreferencesClass parent_class; };
The class structure for PLANK_DRAWING_TYPE_THEME
. All the fields in this structure are private and should never be accessed directly.
PlankServicesPreferencesClass |
the parent class structure |
"BottomRoundness"
property"BottomRoundness" gint : Read / Write
The roundness of the bottom corners.
Default value: 0
"FillEndColor"
property"FillEndColor" PlankDrawingColor* : Read / Write
The ending color (RGBA) of the fill gradient.
"FillStartColor"
property"FillStartColor" PlankDrawingColor* : Read / Write
The starting color (RGBA) of the fill gradient.
"InnerStrokeColor"
property"InnerStrokeColor" PlankDrawingColor* : Read / Write
The color (RGBA) of the inner stroke.
"LineWidth"
property"LineWidth" gint : Read / Write
The thickness (in pixels) of lines drawn.
Default value: 0
"OuterStrokeColor"
property"OuterStrokeColor" PlankDrawingColor* : Read / Write
The color (RGBA) of the outer stroke.
"TopRoundness"
property"TopRoundness" gint : Read / Write
The roundness of the top corners.
Default value: 0