GimpTool

GimpTool

Synopsis

                    GimpTool;
struct              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,
                                                         const GimpCoords *coords,
                                                         guint32 time,
                                                         GdkModifierType state,
                                                         GimpButtonPressType press_type,
                                                         GimpDisplay *display);
void                gimp_tool_button_release            (GimpTool *tool,
                                                         const GimpCoords *coords,
                                                         guint32 time,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);
void                gimp_tool_motion                    (GimpTool *tool,
                                                         const 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);
gboolean            gimp_tool_key_release               (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,
                                                         const GimpCoords *coords,
                                                         GdkModifierType state,
                                                         gboolean proximity,
                                                         GimpDisplay *display);
void                gimp_tool_cursor_update             (GimpTool *tool,
                                                         const GimpCoords *coords,
                                                         GdkModifierType state,
                                                         GimpDisplay *display);
GimpUIManager *     gimp_tool_get_popup                 (GimpTool *tool,
                                                         const GimpCoords *coords,
                                                         GdkModifierType state,
                                                         GimpDisplay *display,
                                                         const gchar **ui_path);
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_message_literal           (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *message);
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

Implemented Interfaces

GimpTool implements GimpProgressInterface.

Properties

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

Description

Details

GimpTool

typedef struct _GimpTool GimpTool;


struct GimpToolClass

struct GimpToolClass {
  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,
                                           const GimpCoords      *coords,
                                           guint32                time,
                                           GdkModifierType        state,
                                           GimpButtonPressType    press_type,
                                           GimpDisplay           *display);
  void            (* button_release)      (GimpTool              *tool,
                                           const GimpCoords      *coords,
                                           guint32                time,
                                           GdkModifierType        state,
                                           GimpButtonReleaseType  release_type,
                                           GimpDisplay           *display);
  void            (* motion)              (GimpTool              *tool,
                                           const GimpCoords      *coords,
                                           guint32                time,
                                           GdkModifierType        state,
                                           GimpDisplay           *display);

  gboolean        (* key_press)           (GimpTool              *tool,
                                           GdkEventKey           *kevent,
                                           GimpDisplay           *display);
  gboolean        (* key_release)         (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,
                                           const GimpCoords      *coords,
                                           GdkModifierType        state,
                                           gboolean               proximity,
                                           GimpDisplay           *display);
  void            (* cursor_update)       (GimpTool              *tool,
                                           const GimpCoords      *coords,
                                           GdkModifierType        state,
                                           GimpDisplay           *display);

  GimpUIManager * (* get_popup)           (GimpTool              *tool,
                                           const GimpCoords      *coords,
                                           GdkModifierType        state,
                                           GimpDisplay           *display,
                                           const gchar          **ui_path);

  void            (* options_notify)      (GimpTool              *tool,
                                           GimpToolOptions       *options,
                                           const GParamSpec      *pspec);
};


gimp_tool_get_options ()

GimpToolOptions *   gimp_tool_get_options               (GimpTool *tool);


gimp_tool_has_display ()

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


gimp_tool_has_image ()

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


gimp_tool_initialize ()

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


gimp_tool_control ()

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


gimp_tool_button_press ()

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


gimp_tool_button_release ()

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


gimp_tool_motion ()

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


gimp_tool_set_focus_display ()

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


gimp_tool_key_press ()

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


gimp_tool_key_release ()

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


gimp_tool_set_modifier_state ()

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


gimp_tool_set_active_modifier_state ()

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


gimp_tool_oper_update ()

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


gimp_tool_cursor_update ()

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


gimp_tool_get_popup ()

GimpUIManager *     gimp_tool_get_popup                 (GimpTool *tool,
                                                         const GimpCoords *coords,
                                                         GdkModifierType state,
                                                         GimpDisplay *display,
                                                         const gchar **ui_path);


gimp_tool_push_status ()

void                gimp_tool_push_status               (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *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);


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);


gimp_tool_replace_status ()

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


gimp_tool_pop_status ()

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


gimp_tool_message ()

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


gimp_tool_message_literal ()

void                gimp_tool_message_literal           (GimpTool *tool,
                                                         GimpDisplay *display,
                                                         const gchar *message);


gimp_tool_set_cursor ()

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


GIMP_TOOL_GET_OPTIONS()

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

Property Details

The "tool-info" property

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