GimpStrokeOptions

GimpStrokeOptions

Synopsis

                    GimpStrokeOptions;
GimpStrokeOptions * gimp_stroke_options_new             (Gimp *gimp,
                                                         GimpContext *context,
                                                         gboolean use_context_color);
GimpStrokeMethod    gimp_stroke_options_get_method      (GimpStrokeOptions *options);
gdouble             gimp_stroke_options_get_width       (GimpStrokeOptions *options);
GimpUnit            gimp_stroke_options_get_unit        (GimpStrokeOptions *options);
GimpCapStyle        gimp_stroke_options_get_cap_style   (GimpStrokeOptions *options);
GimpJoinStyle       gimp_stroke_options_get_join_style  (GimpStrokeOptions *options);
gdouble             gimp_stroke_options_get_miter_limit (GimpStrokeOptions *options);
gdouble             gimp_stroke_options_get_dash_offset (GimpStrokeOptions *options);
GArray *            gimp_stroke_options_get_dash_info   (GimpStrokeOptions *options);
GimpPaintOptions *  gimp_stroke_options_get_paint_options
                                                        (GimpStrokeOptions *options);
gboolean            gimp_stroke_options_get_emulate_dynamics
                                                        (GimpStrokeOptions *options);
void                gimp_stroke_options_take_dash_pattern
                                                        (GimpStrokeOptions *options,
                                                         GimpDashPreset preset,
                                                         GArray *pattern);
void                gimp_stroke_options_prepare         (GimpStrokeOptions *options,
                                                         GimpContext *context,
                                                         gboolean use_default_values);
void                gimp_stroke_options_finish          (GimpStrokeOptions *options);

Object Hierarchy

  GObject
   +----GimpObject
         +----GimpViewable
               +----GimpContext
                     +----GimpFillOptions
                           +----GimpStrokeOptions

Implemented Interfaces

GimpStrokeOptions implements GimpConfigInterface.

Properties

  "cap-style"                GimpCapStyle          : Read / Write / Construct
  "dash-info"                GValueArray*          : Read / Write / Construct
  "dash-offset"              gdouble               : Read / Write / Construct
  "emulate-brush-dynamics"   gboolean              : Read / Write / Construct
  "join-style"               GimpJoinStyle         : Read / Write / Construct
  "method"                   GimpStrokeMethod      : Read / Write / Construct
  "miter-limit"              gdouble               : Read / Write / Construct
  "paint-options"            GimpPaintOptions*     : Read / Write
  "unit"                     GimpUnit              : Read / Write / Construct
  "width"                    gdouble               : Read / Write / Construct

Signals

  "dash-info-changed"                              : Run First

Description

Details

GimpStrokeOptions

typedef struct _GimpStrokeOptions GimpStrokeOptions;


gimp_stroke_options_new ()

GimpStrokeOptions * gimp_stroke_options_new             (Gimp *gimp,
                                                         GimpContext *context,
                                                         gboolean use_context_color);


gimp_stroke_options_get_method ()

GimpStrokeMethod    gimp_stroke_options_get_method      (GimpStrokeOptions *options);


gimp_stroke_options_get_width ()

gdouble             gimp_stroke_options_get_width       (GimpStrokeOptions *options);


gimp_stroke_options_get_unit ()

GimpUnit            gimp_stroke_options_get_unit        (GimpStrokeOptions *options);


gimp_stroke_options_get_cap_style ()

GimpCapStyle        gimp_stroke_options_get_cap_style   (GimpStrokeOptions *options);


gimp_stroke_options_get_join_style ()

GimpJoinStyle       gimp_stroke_options_get_join_style  (GimpStrokeOptions *options);


gimp_stroke_options_get_miter_limit ()

gdouble             gimp_stroke_options_get_miter_limit (GimpStrokeOptions *options);


gimp_stroke_options_get_dash_offset ()

gdouble             gimp_stroke_options_get_dash_offset (GimpStrokeOptions *options);


gimp_stroke_options_get_dash_info ()

GArray *            gimp_stroke_options_get_dash_info   (GimpStrokeOptions *options);


gimp_stroke_options_get_paint_options ()

GimpPaintOptions *  gimp_stroke_options_get_paint_options
                                                        (GimpStrokeOptions *options);


gimp_stroke_options_get_emulate_dynamics ()

gboolean            gimp_stroke_options_get_emulate_dynamics
                                                        (GimpStrokeOptions *options);


gimp_stroke_options_take_dash_pattern ()

void                gimp_stroke_options_take_dash_pattern
                                                        (GimpStrokeOptions *options,
                                                         GimpDashPreset preset,
                                                         GArray *pattern);

Sets the dash pattern. Either a preset is passed and pattern is NULL or preset is GIMP_DASH_CUSTOM and pattern is the GArray to use as the dash pattern. Note that this function takes ownership of the passed pattern.

options :

a GimpStrokeOptions object

preset :

a value out of the GimpDashPreset enum

pattern :

a GArray or NULL if preset is not GIMP_DASH_CUSTOM

gimp_stroke_options_prepare ()

void                gimp_stroke_options_prepare         (GimpStrokeOptions *options,
                                                         GimpContext *context,
                                                         gboolean use_default_values);


gimp_stroke_options_finish ()

void                gimp_stroke_options_finish          (GimpStrokeOptions *options);

Property Details

The "cap-style" property

  "cap-style"                GimpCapStyle          : Read / Write / Construct

Default value: GIMP_CAP_BUTT


The "dash-info" property

  "dash-info"                GValueArray*          : Read / Write / Construct


The "dash-offset" property

  "dash-offset"              gdouble               : Read / Write / Construct

Allowed values: [0,2000]

Default value: 0


The "emulate-brush-dynamics" property

  "emulate-brush-dynamics"   gboolean              : Read / Write / Construct

Default value: FALSE


The "join-style" property

  "join-style"               GimpJoinStyle         : Read / Write / Construct

Default value: GIMP_JOIN_MITER


The "method" property

  "method"                   GimpStrokeMethod      : Read / Write / Construct

Default value: GIMP_STROKE_METHOD_LIBART


The "miter-limit" property

  "miter-limit"              gdouble               : Read / Write / Construct

Convert a mitered join to a bevelled join if the miter would extend to a distance of more than miter-limit * line-width from the actual join point.

Allowed values: [0,100]

Default value: 10


The "paint-options" property

  "paint-options"            GimpPaintOptions*     : Read / Write


The "unit" property

  "unit"                     GimpUnit              : Read / Write / Construct

Allowed values: [0,65535]

Default value: 0


The "width" property

  "width"                    gdouble               : Read / Write / Construct

Allowed values: [0,2000]

Default value: 6

Signal Details

The "dash-info-changed" signal

void                user_function                      (GimpStrokeOptions *gimpstrokeoptions,
                                                        GimpDashPreset     arg1,
                                                        gpointer           user_data)              : Run First

gimpstrokeoptions :

the object which received the signal.

user_data :

user data set when the signal handler was connected.