![]() |
![]() |
![]() |
plank Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#define PLANK_DRAWING_TYPE_DOCK_THEME PlankDrawingDockSurface * plank_drawing_dock_theme_create_background (PlankDrawingDockTheme *self
,gint width
,gint height
,GtkPositionType position
,PlankDrawingDockSurface *model
); PlankDrawingDockSurface * plank_drawing_dock_theme_create_indicator (PlankDrawingDockTheme *self
,gint size
,PlankDrawingColor *color
,PlankDrawingDockSurface *model
); PlankDrawingDockSurface * plank_drawing_dock_theme_create_urgent_glow (PlankDrawingDockTheme *self
,gint size
,PlankDrawingColor *color
,PlankDrawingDockSurface *model
); void plank_drawing_dock_theme_draw_active_glow (PlankDrawingDockTheme *self
,PlankDrawingDockSurface *surface
,GdkRectangle *clip_rect
,GdkRectangle *rect
,PlankDrawingColor *color
,gdouble opacity
,GtkPositionType pos
); void plank_drawing_dock_theme_draw_item_count (PlankDrawingDockTheme *self
,PlankDrawingDockSurface *surface
,gint icon_size
,PlankDrawingColor *color
,gint64 count
); void plank_drawing_dock_theme_draw_item_progress (PlankDrawingDockTheme *self
,PlankDrawingDockSurface *surface
,gint icon_size
,PlankDrawingColor *color
,gdouble progress
); PlankDrawingDockTheme * plank_drawing_dock_theme_new (const gchar *name
); gdouble plank_drawing_dock_theme_get_HorizPadding (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_HorizPadding (PlankDrawingDockTheme *self
,gdouble value
); gdouble plank_drawing_dock_theme_get_TopPadding (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_TopPadding (PlankDrawingDockTheme *self
,gdouble value
); gdouble plank_drawing_dock_theme_get_BottomPadding (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_BottomPadding (PlankDrawingDockTheme *self
,gdouble value
); gdouble plank_drawing_dock_theme_get_ItemPadding (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_ItemPadding (PlankDrawingDockTheme *self
,gdouble value
); gdouble plank_drawing_dock_theme_get_IndicatorSize (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_IndicatorSize (PlankDrawingDockTheme *self
,gdouble value
); gdouble plank_drawing_dock_theme_get_IconShadowSize (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_IconShadowSize (PlankDrawingDockTheme *self
,gdouble value
); gdouble plank_drawing_dock_theme_get_UrgentBounceHeight (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_UrgentBounceHeight (PlankDrawingDockTheme *self
,gdouble value
); gdouble plank_drawing_dock_theme_get_LaunchBounceHeight (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_LaunchBounceHeight (PlankDrawingDockTheme *self
,gdouble value
); gdouble plank_drawing_dock_theme_get_FadeOpacity (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_FadeOpacity (PlankDrawingDockTheme *self
,gdouble value
); gint plank_drawing_dock_theme_get_ClickTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_ClickTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_UrgentBounceTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_UrgentBounceTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_LaunchBounceTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_LaunchBounceTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_ActiveTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_ActiveTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_SlideTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_SlideTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_FadeTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_FadeTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_HideTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_HideTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_GlowSize (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_GlowSize (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_GlowTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_GlowTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_GlowPulseTime (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_GlowPulseTime (PlankDrawingDockTheme *self
,gint value
); gint plank_drawing_dock_theme_get_UrgentHueShift (PlankDrawingDockTheme *self
); void plank_drawing_dock_theme_set_UrgentHueShift (PlankDrawingDockTheme *self
,gint value
); struct PlankDrawingDockTheme; struct PlankDrawingDockThemeClass;
GObject +----PlankServicesPreferences +----PlankDrawingTheme +----PlankDrawingDockTheme
"ActiveTime" gint : Read / Write "BottomPadding" gdouble : Read / Write "ClickTime" gint : Read / Write "FadeOpacity" gdouble : Read / Write "FadeTime" gint : Read / Write "GlowPulseTime" gint : Read / Write "GlowSize" gint : Read / Write "GlowTime" gint : Read / Write "HideTime" gint : Read / Write "HorizPadding" gdouble : Read / Write "IconShadowSize" gdouble : Read / Write "IndicatorSize" gdouble : Read / Write "ItemPadding" gdouble : Read / Write "LaunchBounceHeight" gdouble : Read / Write "LaunchBounceTime" gint : Read / Write "SlideTime" gint : Read / Write "TopPadding" gdouble : Read / Write "UrgentBounceHeight" gdouble : Read / Write "UrgentBounceTime" gint : Read / Write "UrgentHueShift" gint : Read / Write
#define PLANK_DRAWING_TYPE_DOCK_THEME (plank_drawing_dock_theme_get_type ())
The type for PlankDrawingDockTheme.
PlankDrawingDockSurface * plank_drawing_dock_theme_create_background (PlankDrawingDockTheme *self
,gint width
,gint height
,GtkPositionType position
,PlankDrawingDockSurface *model
);
Creates a surface for the dock background.
|
the PlankDrawingDockTheme instance |
|
. the width of the background. [in] |
|
. the height of the background. [in] |
|
. the position of the dock. [in] |
|
. existing surface to use as basis of new surface. [in] |
Returns : |
a new dock surface with the background drawn on it |
PlankDrawingDockSurface * plank_drawing_dock_theme_create_indicator (PlankDrawingDockTheme *self
,gint size
,PlankDrawingColor *color
,PlankDrawingDockSurface *model
);
Creates a surface for an indicator.
|
the PlankDrawingDockTheme instance |
|
. the size of the indicator. [in] |
|
. the color of the indicator. [in] |
|
. existing surface to use as basis of new surface. [in] |
Returns : |
a new dock surface with the indicator drawn on it |
PlankDrawingDockSurface * plank_drawing_dock_theme_create_urgent_glow (PlankDrawingDockTheme *self
,gint size
,PlankDrawingColor *color
,PlankDrawingDockSurface *model
);
Creates a surface for an urgent glow.
|
the PlankDrawingDockTheme instance |
|
. the size of the urgent glow. [in] |
|
. the color of the urgent glow. [in] |
|
. existing surface to use as basis of new surface. [in] |
Returns : |
a new dock surface with the urgent glow drawn on it |
void plank_drawing_dock_theme_draw_active_glow (PlankDrawingDockTheme *self
,PlankDrawingDockSurface *surface
,GdkRectangle *clip_rect
,GdkRectangle *rect
,PlankDrawingColor *color
,gdouble opacity
,GtkPositionType pos
);
Draws an active glow for an item.
|
the PlankDrawingDockTheme instance |
|
. the surface to draw onto. [in] |
|
. the rect to clip the glow to. [in] |
|
. the rect for the glow. [in] |
|
. the color of the glow. [in] |
|
. the opacity of the glow. [in] |
|
. the dock's position. [in] |
void plank_drawing_dock_theme_draw_item_count (PlankDrawingDockTheme *self
,PlankDrawingDockSurface *surface
,gint icon_size
,PlankDrawingColor *color
,gint64 count
);
Draws a badge for an item.
|
the PlankDrawingDockTheme instance |
|
. the surface to draw the badge onto. [in] |
|
. the icon-size of the dock. [in] |
|
. the color of the badge. [in] |
|
. the number for the badge to show. [in] |
void plank_drawing_dock_theme_draw_item_progress (PlankDrawingDockTheme *self
,PlankDrawingDockSurface *surface
,gint icon_size
,PlankDrawingColor *color
,gdouble progress
);
Draws a progress bar for an item.
|
the PlankDrawingDockTheme instance |
|
. the surface to draw the progress onto. [in] |
|
. the icon-size of the dock. [in] |
|
. the color of the progress. [in] |
|
. the value between 0.0 and 1.0. [in] |
PlankDrawingDockTheme * plank_drawing_dock_theme_new (const gchar *name
);
|
gdouble plank_drawing_dock_theme_get_HorizPadding
(PlankDrawingDockTheme *self
);
Get and return the current value of the "horizontal-padding" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "horizontal-padding" property |
void plank_drawing_dock_theme_set_HorizPadding (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "horizontal-padding" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "horizontal-padding" property |
gdouble plank_drawing_dock_theme_get_TopPadding
(PlankDrawingDockTheme *self
);
Get and return the current value of the "top-padding" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "top-padding" property |
void plank_drawing_dock_theme_set_TopPadding (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "top-padding" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "top-padding" property |
gdouble plank_drawing_dock_theme_get_BottomPadding
(PlankDrawingDockTheme *self
);
Get and return the current value of the "top-padding" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "top-padding" property |
void plank_drawing_dock_theme_set_BottomPadding (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "top-padding" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "top-padding" property |
gdouble plank_drawing_dock_theme_get_ItemPadding
(PlankDrawingDockTheme *self
);
Get and return the current value of the "item-padding" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "item-padding" property |
void plank_drawing_dock_theme_set_ItemPadding (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "item-padding" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "item-padding" property |
gdouble plank_drawing_dock_theme_get_IndicatorSize
(PlankDrawingDockTheme *self
);
Get and return the current value of the "indicator-size" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "indicator-size" property |
void plank_drawing_dock_theme_set_IndicatorSize (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "indicator-size" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "indicator-size" property |
gdouble plank_drawing_dock_theme_get_IconShadowSize
(PlankDrawingDockTheme *self
);
Get and return the current value of the "icon-shadow-size" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "icon-shadow-size" property |
void plank_drawing_dock_theme_set_IconShadowSize (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "icon-shadow-size" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "icon-shadow-size" property |
gdouble plank_drawing_dock_theme_get_UrgentBounceHeight
(PlankDrawingDockTheme *self
);
Get and return the current value of the "urgent-bounce" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "urgent-bounce" property |
void plank_drawing_dock_theme_set_UrgentBounceHeight (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "urgent-bounce" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "urgent-bounce" property |
gdouble plank_drawing_dock_theme_get_LaunchBounceHeight
(PlankDrawingDockTheme *self
);
Get and return the current value of the "launch-bounce" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "launch-bounce" property |
void plank_drawing_dock_theme_set_LaunchBounceHeight (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "launch-bounce" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "launch-bounce" property |
gdouble plank_drawing_dock_theme_get_FadeOpacity
(PlankDrawingDockTheme *self
);
Get and return the current value of the "fade-opacity" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "fade-opacity" property |
void plank_drawing_dock_theme_set_FadeOpacity (PlankDrawingDockTheme *self
,gdouble value
);
Set the value of the "fade-opacity" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "fade-opacity" property |
gint plank_drawing_dock_theme_get_ClickTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "click-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "click-time" property |
void plank_drawing_dock_theme_set_ClickTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "click-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "click-time" property |
gint plank_drawing_dock_theme_get_UrgentBounceTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "urgent-bounce-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "urgent-bounce-time" property |
void plank_drawing_dock_theme_set_UrgentBounceTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "urgent-bounce-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "urgent-bounce-time" property |
gint plank_drawing_dock_theme_get_LaunchBounceTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "launch-bounce-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "launch-bounce-time" property |
void plank_drawing_dock_theme_set_LaunchBounceTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "launch-bounce-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "launch-bounce-time" property |
gint plank_drawing_dock_theme_get_ActiveTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "active-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "active-time" property |
void plank_drawing_dock_theme_set_ActiveTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "active-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "active-time" property |
gint plank_drawing_dock_theme_get_SlideTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "slide-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "slide-time" property |
void plank_drawing_dock_theme_set_SlideTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "slide-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "slide-time" property |
gint plank_drawing_dock_theme_get_FadeTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "fade-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "fade-time" property |
void plank_drawing_dock_theme_set_FadeTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "fade-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "fade-time" property |
gint plank_drawing_dock_theme_get_HideTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "hide-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "hide-time" property |
void plank_drawing_dock_theme_set_HideTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "hide-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "hide-time" property |
gint plank_drawing_dock_theme_get_GlowSize
(PlankDrawingDockTheme *self
);
Get and return the current value of the "glow-size" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "glow-size" property |
void plank_drawing_dock_theme_set_GlowSize (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "glow-size" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "glow-size" property |
gint plank_drawing_dock_theme_get_GlowTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "glow-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "glow-time" property |
void plank_drawing_dock_theme_set_GlowTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "glow-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "glow-time" property |
gint plank_drawing_dock_theme_get_GlowPulseTime
(PlankDrawingDockTheme *self
);
Get and return the current value of the "glow-pulse-time" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "glow-pulse-time" property |
void plank_drawing_dock_theme_set_GlowPulseTime (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "glow-pulse-time" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "glow-pulse-time" property |
gint plank_drawing_dock_theme_get_UrgentHueShift
(PlankDrawingDockTheme *self
);
Get and return the current value of the "urgent-hue-shift" property.
|
the PlankDrawingDockTheme instance to query |
Returns : |
the value of the "urgent-hue-shift" property |
void plank_drawing_dock_theme_set_UrgentHueShift (PlankDrawingDockTheme *self
,gint value
);
Set the value of the "urgent-hue-shift" property to value
.
|
the PlankDrawingDockTheme instance to modify |
|
the new value of the "urgent-hue-shift" property |
struct PlankDrawingDockThemeClass { PlankDrawingThemeClass parent_class; };
The class structure for PLANK_DRAWING_TYPE_DOCK_THEME
. All the fields in this structure are private and should never be accessed directly.
PlankDrawingThemeClass |
the parent class structure |
"ActiveTime"
property"ActiveTime" gint : Read / Write
The amount of time (in ms) for active window indicator animations.
Default value: 0
"BottomPadding"
property"BottomPadding" gdouble : Read / Write
The padding on the bottom dock edge, in tenths of a percent of IconSize.
Default value: 0
"ClickTime"
property"ClickTime" gint : Read / Write
The amount of time (in ms) for click animations.
Default value: 0
"FadeOpacity"
property"FadeOpacity" gdouble : Read / Write
The opacity value (0 to 1) to fade the dock to when hiding it.
Default value: 0
"FadeTime"
property"FadeTime" gint : Read / Write
The time (in ms) to fade the dock in/out on a hide (if FadeOpacity is < 1).
Default value: 0
"GlowPulseTime"
property"GlowPulseTime" gint : Read / Write
The time (in ms) of each pulse of the hidden-dock urgent glow.
Default value: 0
"GlowSize"
property"GlowSize" gint : Read / Write
The size of the urgent glow (shown when dock is hidden), in tenths of a percent of IconSize.
Default value: 0
"GlowTime"
property"GlowTime" gint : Read / Write
The total time (in ms) to show the hidden-dock urgent glow.
Default value: 0
"HideTime"
property"HideTime" gint : Read / Write
The time (in ms) to slide the dock in/out on a hide (if FadeOpacity is 1).
Default value: 0
"HorizPadding"
property"HorizPadding" gdouble : Read / Write
The padding on the left/right dock edges, in tenths of a percent of IconSize.
Default value: 0
"IconShadowSize"
property"IconShadowSize" gdouble : Read / Write
The size of the icon-shadow behind every item, in tenths of a percent of IconSize.
Default value: 0
"IndicatorSize"
property"IndicatorSize" gdouble : Read / Write
The size of item indicators, in tenths of a percent of IconSize.
Default value: 0
"ItemPadding"
property"ItemPadding" gdouble : Read / Write
The padding between items on the dock, in tenths of a percent of IconSize.
Default value: 0
"LaunchBounceHeight"
property"LaunchBounceHeight" gdouble : Read / Write
The height (in percent of IconSize) to bounce an icon when launching an application.
Default value: 0
"LaunchBounceTime"
property"LaunchBounceTime" gint : Read / Write
The amount of time (in ms) to bounce an icon when launching an application.
Default value: 0
"SlideTime"
property"SlideTime" gint : Read / Write
The amount of time (in ms) to slide icons into/out of the dock.
Default value: 0
"TopPadding"
property"TopPadding" gdouble : Read / Write
The padding on the top dock edge, in tenths of a percent of IconSize.
Default value: 0
"UrgentBounceHeight"
property"UrgentBounceHeight" gdouble : Read / Write
The height (in percent of IconSize) to bounce an icon when the application sets urgent.
Default value: 0
"UrgentBounceTime"
property"UrgentBounceTime" gint : Read / Write
The amount of time (in ms) to bounce an urgent icon.
Default value: 0
"UrgentHueShift"
property"UrgentHueShift" gint : Read / Write
The hue-shift (-180 to 180) of the urgent indicator color.
Default value: 0