GimpGuide

GimpGuide

Synopsis

                    GimpGuide;
GimpGuide *         gimp_guide_new                      (GimpOrientationType orientation,
                                                         guint32 guide_ID);
guint32             gimp_guide_get_ID                   (GimpGuide *guide);
GimpOrientationType gimp_guide_get_orientation          (GimpGuide *guide);
void                gimp_guide_set_orientation          (GimpGuide *guide,
                                                         GimpOrientationType orientation);
gint                gimp_guide_get_position             (GimpGuide *guide);
void                gimp_guide_set_position             (GimpGuide *guide,
                                                         gint position);
void                gimp_guide_removed                  (GimpGuide *guide);

Object Hierarchy

  GObject
   +----GimpGuide

Properties

  "id"                       guint                 : Read / Write / Construct Only
  "orientation"              GimpOrientationType   : Read / Write / Construct
  "position"                 gint                  : Read / Write / Construct

Signals

  "removed"                                        : Run First

Description

Details

GimpGuide

typedef struct _GimpGuide GimpGuide;


gimp_guide_new ()

GimpGuide *         gimp_guide_new                      (GimpOrientationType orientation,
                                                         guint32 guide_ID);


gimp_guide_get_ID ()

guint32             gimp_guide_get_ID                   (GimpGuide *guide);


gimp_guide_get_orientation ()

GimpOrientationType gimp_guide_get_orientation          (GimpGuide *guide);


gimp_guide_set_orientation ()

void                gimp_guide_set_orientation          (GimpGuide *guide,
                                                         GimpOrientationType orientation);


gimp_guide_get_position ()

gint                gimp_guide_get_position             (GimpGuide *guide);


gimp_guide_set_position ()

void                gimp_guide_set_position             (GimpGuide *guide,
                                                         gint position);


gimp_guide_removed ()

void                gimp_guide_removed                  (GimpGuide *guide);

Property Details

The "id" property

  "id"                       guint                 : Read / Write / Construct Only

Default value: 0


The "orientation" property

  "orientation"              GimpOrientationType   : Read / Write / Construct

Default value: GIMP_ORIENTATION_UNKNOWN


The "position" property

  "position"                 gint                  : Read / Write / Construct

Allowed values: [-1,262144]

Default value: -1

Signal Details

The "removed" signal

void                user_function                      (GimpGuide *gimpguide,
                                                        gpointer   user_data)      : Run First

gimpguide :

the object which received the signal.

user_data :

user data set when the signal handler was connected.