GpeClockFace

GpeClockFace — Clock face widget

Synopsis




#define             GPE_TYPE_CLOCK_FACE
#define             GPE_CLOCK_FACE                      (obj)
#define             GTK_CLOCK_GET_CLASS                 (obj)
                    GpeClockFace;
                    GpeClockFaceClass;
GtkType             gpe_clock_face_get_type             (void);
GtkWidget*          gpe_clock_face_new                  (GtkAdjustment *,
                                                         GtkAdjustment *,
                                                         GtkAdjustment *);
void                gpe_clock_face_set_do_grabs         (GpeClockFace *clock,
                                                         gboolean yes);
void                gpe_clock_face_set_radius           (GpeClockFace *clock,
                                                         guint radius);
void                gpe_clock_face_set_use_background_image
                                                        (GpeClockFace *clock,
                                                         gboolean yes);
void                gpe_clock_face_set_label_hours      (GpeClockFace *clock,
                                                         gboolean yes);
void                gpe_clock_face_set_hand_width       (GpeClockFace *clock,
                                                         double width);
void                gpe_clock_face_set_border           (GpeClockFace *clock,
                                                         guint border);
GdkBitmap*          gpe_clock_face_get_shape            (GpeClockFace *clock);

Description

A widget to display an analogue clock face.

Details

GPE_TYPE_CLOCK_FACE

#define GPE_TYPE_CLOCK_FACE          (gpe_clock_face_get_type ())

Type checking macro.


GPE_CLOCK_FACE()

#define GPE_CLOCK_FACE(obj)          G_TYPE_CHECK_INSTANCE_CAST ((obj), gpe_clock_face_get_type(), GpeClockFace)

Macro to cast a an object (usually GtkWidget*) to GpeClockFace type.

obj : Object to cast.

GTK_CLOCK_GET_CLASS()

#define GTK_CLOCK_GET_CLASS(obj)	G_TYPE_INSTANCE_GET_CLASS ((obj), gpe_clock_face_get_type(), GpeClockFaceClass)

Macro to return class from object instance.

obj :

GpeClockFace

typedef struct _GpeClockFace GpeClockFace;

Object container for the GpeClockFace widget.


GpeClockFaceClass

typedef struct _GpeClockFaceClass GpeClockFaceClass;

Object container for the GpeClockFaceClass widget.


gpe_clock_face_get_type ()

GtkType             gpe_clock_face_get_type             (void);

Returns type for a GpeClockFace widget. Internally used to create a new instance of a GpeClockFace.

Returns : Object type

gpe_clock_face_new ()

GtkWidget*          gpe_clock_face_new                  (GtkAdjustment *,
                                                         GtkAdjustment *,
                                                         GtkAdjustment *);

Create a new instance of a GpeClockFace widget.

Param1 : Adjustmennt for hour setting.
Param2 : Adjustment for minute setting.
Param3 : Adjustment for second setting.
Returns : New GpeClockFace widget.

gpe_clock_face_set_do_grabs ()

void                gpe_clock_face_set_do_grabs         (GpeClockFace *clock,
                                                         gboolean yes);

Set wether to allow user interactive moving of the hands or not.

clock : Widget
yes : TRUE to allow, FALSE to deny

gpe_clock_face_set_radius ()

void                gpe_clock_face_set_radius           (GpeClockFace *clock,
                                                         guint radius);

Sets the radius of the clockface (in pixels).

clock : Widget
radius : New radius.

gpe_clock_face_set_use_background_image ()

void                gpe_clock_face_set_use_background_image
                                                        (GpeClockFace *clock,
                                                         gboolean yes);

Set if the widget should use a background image.

clock : Widget
yes : TRUE to enable, FALSE to disable

gpe_clock_face_set_label_hours ()

void                gpe_clock_face_set_label_hours      (GpeClockFace *clock,
                                                         gboolean yes);

Turn hour labels on the clockface on/off.

clock : Widget
yes : TRUE to enable, FALSE to disable

gpe_clock_face_set_hand_width ()

void                gpe_clock_face_set_hand_width       (GpeClockFace *clock,
                                                         double width);

Change the width of clock hands.

clock : Widget
width : New with in pixels.

gpe_clock_face_set_border ()

void                gpe_clock_face_set_border           (GpeClockFace *clock,
                                                         guint border);

clock :
border :

gpe_clock_face_get_shape ()

GdkBitmap*          gpe_clock_face_get_shape            (GpeClockFace *clock);

Returns the shape mask of the given clockface widget. This is used to set up a shaped window only containing a GtkClockFace widget.

clock : Widget
Returns : The widget's shape mask

See Also

Used by: GpeTimeSel widget, gpe-watch, gpe-clock