PlankDockRenderer

PlankDockRenderer — Handles all of the drawing for a dock.

Synopsis

#define             PLANK_TYPE_DOCK_RENDERER
gdouble             plank_dock_renderer_get_hide_progress
                                                        (PlankDockRenderer *self);
void                plank_dock_renderer_initialize      (PlankDockRenderer *self);
void                plank_dock_renderer_reset_buffers   (PlankDockRenderer *self);
void                plank_dock_renderer_draw_dock       (PlankDockRenderer *self,
                                                         cairo_t *cr);
PlankDockRenderer * plank_dock_renderer_new             (PlankDockController *controller);
struct              PlankDockRenderer;
struct              PlankDockRendererClass;

Object Hierarchy

  GObject
   +----PlankDrawingAnimatedRenderer
         +----PlankDockRenderer

Properties

  "controller"               PlankDockController*  : Write / Construct Only

Description

Details

PLANK_TYPE_DOCK_RENDERER

#define PLANK_TYPE_DOCK_RENDERER (plank_dock_renderer_get_type ())

The type for PlankDockRenderer.

plank_dock_renderer_get_hide_progress ()

gdouble             plank_dock_renderer_get_hide_progress
                                                        (PlankDockRenderer *self);

Returns the current progress of the hide-animation of the dock.

`self` :	the PlankDockRenderer instance
Returns :	the hide-animation progress [0.0..1.0]

plank_dock_renderer_initialize ()

void                plank_dock_renderer_initialize      (PlankDockRenderer *self);

Initializes the renderer. Call after the DockWindow is constructed.

self :

the PlankDockRenderer instance

plank_dock_renderer_reset_buffers ()

void                plank_dock_renderer_reset_buffers   (PlankDockRenderer *self);

Resets all internal buffers and forces a redraw.

self :

the PlankDockRenderer instance

plank_dock_renderer_draw_dock ()

void                plank_dock_renderer_draw_dock       (PlankDockRenderer *self,
                                                         cairo_t *cr);

Draws the dock onto a context.

`self` :	the PlankDockRenderer instance
`cr` :	. the context to use for drawing. [in]

plank_dock_renderer_new ()

PlankDockRenderer * plank_dock_renderer_new             (PlankDockController *controller);

Create a new dock renderer for a dock.

controller :

. the dock controller to manage drawing for. [in]

struct PlankDockRenderer

struct PlankDockRenderer;

Handles all of the drawing for a dock.

struct PlankDockRendererClass

struct PlankDockRendererClass {
	PlankDrawingAnimatedRendererClass parent_class;
};

The class structure for PLANK_TYPE_DOCK_RENDERER. All the fields in this structure are private and should never be accessed directly.

PlankDrawingAnimatedRendererClass parent_class;

the parent class structure

Property Details

The `"controller"` property

  "controller"               PlankDockController*  : Write / Construct Only

controller.

			plank Reference Manual
Top \| Description \| Object Hierarchy \| Properties