ClutterRectangle

ClutterRectangle — An actor that displays simple rectangles.

Synopsis




            ClutterRectangle;
            ClutterRectangleClass;
ClutterActor* clutter_rectangle_new         (void);
ClutterActor* clutter_rectangle_new_with_color
                                            (const ClutterColor *color);
void        clutter_rectangle_get_color     (ClutterRectangle *rectangle,
                                             ClutterColor *color);
void        clutter_rectangle_set_color     (ClutterRectangle *rectangle,
                                             const ClutterColor *color);
void        clutter_rectangle_get_border_color
                                            (ClutterRectangle *rectangle,
                                             ClutterColor *color);
void        clutter_rectangle_set_border_color
                                            (ClutterRectangle *rectangle,
                                             const ClutterColor *color);
guint       clutter_rectangle_get_border_width
                                            (ClutterRectangle *rectangle);
void        clutter_rectangle_set_border_width
                                            (ClutterRectangle *rectangle,
                                             guint width);


Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----ClutterRectangle

Properties


  "border-color"         ClutterColor          : Read / Write
  "border-width"         guint                 : Read / Write
  "color"                ClutterColor          : Read / Write
  "has-border"           gboolean              : Read / Write

Description

ClutterRectangle is an Actor which draws simple filled rectangles.

Details

ClutterRectangle

typedef struct _ClutterRectangle ClutterRectangle;

ClutterRectangle has no publicly available members.


ClutterRectangleClass

typedef struct {
  ClutterActorClass parent_class;

  /* padding for future expansion */
  void (*_clutter_rectangle1) (void);
  void (*_clutter_rectangle2) (void);
  void (*_clutter_rectangle3) (void);
  void (*_clutter_rectangle4) (void);
} ClutterRectangleClass;


clutter_rectangle_new ()

ClutterActor* clutter_rectangle_new         (void);

Creates a new ClutterActor with a rectangular shape.

Returns : a new ClutterActor

clutter_rectangle_new_with_color ()

ClutterActor* clutter_rectangle_new_with_color
                                            (const ClutterColor *color);

Creates a new ClutterActor with a rectangular shape and with color.

color : a ClutterColor
Returns : a new ClutterActor

clutter_rectangle_get_color ()

void        clutter_rectangle_get_color     (ClutterRectangle *rectangle,
                                             ClutterColor *color);

Retrieves the color of rectangle.

rectangle : a ClutterRectangle
color : return location for a ClutterColor

clutter_rectangle_set_color ()

void        clutter_rectangle_set_color     (ClutterRectangle *rectangle,
                                             const ClutterColor *color);

Sets the color of rectangle.

rectangle : a ClutterRectangle
color : a ClutterColor

clutter_rectangle_get_border_color ()

void        clutter_rectangle_get_border_color
                                            (ClutterRectangle *rectangle,
                                             ClutterColor *color);

Gets the color of the border used by rectangle and places it into color.

rectangle : a ClutterRectangle
color : return location for a ClutterColor

Since 0.2


clutter_rectangle_set_border_color ()

void        clutter_rectangle_set_border_color
                                            (ClutterRectangle *rectangle,
                                             const ClutterColor *color);

Sets the color of the border used by rectangle using color

rectangle : a ClutterRectangle
color : the color of the border

clutter_rectangle_get_border_width ()

guint       clutter_rectangle_get_border_width
                                            (ClutterRectangle *rectangle);

Gets the width (in pixels) of the border used by rectangle

rectangle : a ClutterRectangle
Returns : the border's width

Since 0.2


clutter_rectangle_set_border_width ()

void        clutter_rectangle_set_border_width
                                            (ClutterRectangle *rectangle,
                                             guint width);

Sets the width (in pixel) of the border used by rectangle. A width of 0 will unset the border.

rectangle : a ClutterRectangle
width : the width of the border

Since 0.2

Property Details

The "border-color" property

  "border-color"         ClutterColor          : Read / Write

The color of the border of the rectangle.

Since 0.2


The "border-width" property

  "border-width"         guint                 : Read / Write

The width of the border of the rectangle, in pixels.

Default value: 0

Since 0.2


The "color" property

  "color"                ClutterColor          : Read / Write

The color of the rectangle.


The "has-border" property

  "has-border"           gboolean              : Read / Write

Whether the ClutterRectangle should be displayed with a border.

Default value: FALSE

Since 0.2