GimpTool

GimpTool

Synopsis

                    GimpTool;
                    GimpToolClass;
GimpToolOptions*    gimp_tool_get_options               (GimpTool *tool);
gboolean            gimp_tool_has_display               (GimpTool *tool,
                                                         GimpDisplay *display);
GimpDisplay*        gimp_tool_has_image                 (GimpTool *tool,
                                                         GimpImage *image);
gboolean            gimp_tool_initialize                (GimpTool *tool,
                                                         GimpDisplay *display);
void                gimp_tool_control                   (GimpTool *tool,
                                                         GimpToolAction action,
                                                         GimpDisplay *display);
void                gimp_tool_button_press              (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         guint32 time,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);
void                gimp_tool_button_release            (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         guint32 time,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);
void                gimp_tool_motion                    (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         guint32 time,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);
void                gimp_tool_set_focus_display         (GimpTool *tool,
                                                         GimpDisplay *display);
gboolean            gimp_tool_key_press                 (GimpTool *tool,
                                                         GdkEventKey *kevent,
                                                         GimpDisplay *display);
void                gimp_tool_set_modifier_state        (GimpTool *tool,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);
void                gimp_tool_set_active_modifier_state (GimpTool *tool,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);
void                gimp_tool_oper_update               (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         GdkModifierType state,
                                                         gboolean proximity,
                                                         GimpDisplay *display);
void                gimp_tool_cursor_update             (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);
void                gimp_tool_push_status               (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *format,
                                                         ...);
void                gimp_tool_push_status_coords        (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         GimpCursorPrecision precision,
                                                         const gchar *title,
                                                         gdouble x,
                                                         const gchar *separator,
                                                         gdouble y,
                                                         const gchar *help);
void                gimp_tool_push_status_length        (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *title,
                                                         GimpOrientationType axis,
                                                         gdouble value,
                                                         const gchar *help);
void                gimp_tool_replace_status            (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *format,
                                                         ...);
void                gimp_tool_pop_status                (GimpTool *tool,
                                                         GimpDisplay *display);
void                gimp_tool_message                   (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *format,
                                                         ...);
void                gimp_tool_set_cursor                (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         GimpCursorType cursor,
                                                         GimpToolCursorType tool_cursor,
                                                         GimpCursorModifier modifier);
#define             GIMP_TOOL_GET_OPTIONS               (t)

Object Hierarchy

  GObject
   +----GimpObject
         +----GimpTool
               +----GimpDrawTool
               +----GimpBucketFillTool

Properties

  "tool-info"                GimpToolInfo*         : Read / Write / Construct Only

Description

Details

GimpTool

typedef struct _GimpTool GimpTool;

GimpToolClass

typedef struct {
  GimpObjectClass  parent_class;

  /*  virtual functions  */

  gboolean      (* has_display)         (GimpTool              *tool,
                                         GimpDisplay           *display);
  GimpDisplay * (* has_image)           (GimpTool              *tool,
                                         GimpImage             *image);

  gboolean      (* initialize)          (GimpTool              *tool,
                                         GimpDisplay           *display,
                                         GError               **error);
  void          (* control)             (GimpTool              *tool,
                                         GimpToolAction         action,
                                         GimpDisplay           *display);

  void          (* button_press)        (GimpTool              *tool,
                                         GimpCoords            *coords,
                                         guint32                time,
                                         GdkModifierType        state,
                                         GimpDisplay           *display);
  void          (* button_release)      (GimpTool              *tool,
                                         GimpCoords            *coords,
                                         guint32                time,
                                         GdkModifierType        state,
                                         GimpButtonReleaseType  release_type,
                                         GimpDisplay           *display);
  void          (* motion)              (GimpTool              *tool,
                                         GimpCoords            *coords,
                                         guint32                time,
                                         GdkModifierType        state,
                                         GimpDisplay           *display);

  gboolean      (* key_press)           (GimpTool              *tool,
                                         GdkEventKey           *kevent,
                                         GimpDisplay           *display);
  void          (* modifier_key)        (GimpTool              *tool,
                                         GdkModifierType        key,
                                         gboolean               press,
                                         GdkModifierType        state,
                                         GimpDisplay           *display);
  void          (* active_modifier_key) (GimpTool              *tool,
                                         GdkModifierType        key,
                                         gboolean               press,
                                         GdkModifierType        state,
                                         GimpDisplay           *display);

  void          (* oper_update)         (GimpTool              *tool,
                                         GimpCoords            *coords,
                                         GdkModifierType        state,
                                         gboolean               proximity,
                                         GimpDisplay           *display);
  void          (* cursor_update)       (GimpTool              *tool,
                                         GimpCoords            *coords,
                                         GdkModifierType        state,
                                         GimpDisplay           *display);
} GimpToolClass;

gimp_tool_get_options ()

GimpToolOptions*    gimp_tool_get_options               (GimpTool *tool);

tool :

Returns :

gimp_tool_has_display ()

gboolean            gimp_tool_has_display               (GimpTool *tool,
                                                         GimpDisplay *display);

tool :

display :

Returns :

gimp_tool_has_image ()

GimpDisplay*        gimp_tool_has_image                 (GimpTool *tool,
                                                         GimpImage *image);

tool :

image :

Returns :

gimp_tool_initialize ()

gboolean            gimp_tool_initialize                (GimpTool *tool,
                                                         GimpDisplay *display);

tool :

display :

Returns :

gimp_tool_control ()

void                gimp_tool_control                   (GimpTool *tool,
                                                         GimpToolAction action,
                                                         GimpDisplay *display);

tool :

action :

display :

gimp_tool_button_press ()

void                gimp_tool_button_press              (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         guint32 time,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);

tool :

coords :

time :

state :

display :

gimp_tool_button_release ()

void                gimp_tool_button_release            (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         guint32 time,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);

tool :

coords :

time :

state :

display :

gimp_tool_motion ()

void                gimp_tool_motion                    (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         guint32 time,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);

tool :

coords :

time :

state :

display :

gimp_tool_set_focus_display ()

void                gimp_tool_set_focus_display         (GimpTool *tool,
                                                         GimpDisplay *display);

tool :

display :

gimp_tool_key_press ()

gboolean            gimp_tool_key_press                 (GimpTool *tool,
                                                         GdkEventKey *kevent,
                                                         GimpDisplay *display);

tool :

kevent :

display :

Returns :

gimp_tool_set_modifier_state ()

void                gimp_tool_set_modifier_state        (GimpTool *tool,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);

tool :

state :

display :

gimp_tool_set_active_modifier_state ()

void                gimp_tool_set_active_modifier_state (GimpTool *tool,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);

tool :

state :

display :

gimp_tool_oper_update ()

void                gimp_tool_oper_update               (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         GdkModifierType state,
                                                         gboolean proximity,
                                                         GimpDisplay *display);

tool :

coords :

state :

proximity :

display :

gimp_tool_cursor_update ()

void                gimp_tool_cursor_update             (GimpTool *tool,
                                                         GimpCoords *coords,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);

tool :

coords :

state :

display :

gimp_tool_push_status ()

void                gimp_tool_push_status               (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *format,
                                                         ...);

tool :

display :

format :

... :

gimp_tool_push_status_coords ()

void                gimp_tool_push_status_coords        (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         GimpCursorPrecision precision,
                                                         const gchar *title,
                                                         gdouble x,
                                                         const gchar *separator,
                                                         gdouble y,
                                                         const gchar *help);

tool :

display :

precision :

title :

x :

separator :

y :

help :

gimp_tool_push_status_length ()

void                gimp_tool_push_status_length        (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *title,
                                                         GimpOrientationType axis,
                                                         gdouble value,
                                                         const gchar *help);

tool :

display :

title :

axis :

value :

help :

gimp_tool_replace_status ()

void                gimp_tool_replace_status            (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *format,
                                                         ...);

tool :

display :

format :

... :

gimp_tool_pop_status ()

void                gimp_tool_pop_status                (GimpTool *tool,
                                                         GimpDisplay *display);

tool :

display :

gimp_tool_message ()

void                gimp_tool_message                   (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *format,
                                                         ...);

tool :

display :

format :

... :

gimp_tool_set_cursor ()

void                gimp_tool_set_cursor                (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         GimpCursorType cursor,
                                                         GimpToolCursorType tool_cursor,
                                                         GimpCursorModifier modifier);

tool :

display :

cursor :

tool_cursor :

modifier :

GIMP_TOOL_GET_OPTIONS()

#define GIMP_TOOL_GET_OPTIONS(t)  (gimp_tool_get_options (GIMP_TOOL (t)))

t :

Property Details

The "tool-info" property

  "tool-info"                GimpToolInfo*         : Read / Write / Construct Only

Generated by GTK-Doc V1.10