1997-11-24 22:05:25 +00:00
|
|
|
/* The GIMP -- an image manipulation program
|
|
|
|
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
1998-04-13 05:44:11 +00:00
|
|
|
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
1997-11-24 22:05:25 +00:00
|
|
|
*/
|
2000-12-16 21:37:03 +00:00
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
#ifndef __TOOL_H__
|
|
|
|
#define __TOOL_H__
|
1997-11-24 22:05:25 +00:00
|
|
|
|
2001-02-14 14:57:14 +00:00
|
|
|
|
|
|
|
#include "gimpobject.h"
|
2000-01-19 19:06:13 +00:00
|
|
|
|
|
|
|
|
1997-11-24 22:05:25 +00:00
|
|
|
/* The possibilities for where the cursor lies */
|
1999-06-21 22:12:07 +00:00
|
|
|
#define ACTIVE_LAYER (1 << 0)
|
|
|
|
#define SELECTION (1 << 1)
|
|
|
|
#define NON_ACTIVE_LAYER (1 << 2)
|
1997-11-24 22:05:25 +00:00
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
|
2001-02-21 12:18:09 +00:00
|
|
|
#define GIMP_TYPE_TOOL (gimp_tool_get_type ())
|
|
|
|
#define GIMP_TOOL(obj) (GTK_CHECK_CAST ((obj), GIMP_TYPE_TOOL, GimpTool))
|
|
|
|
#define GIMP_IS_TOOL(obj) (GTK_CHECK_TYPE ((obj), GIMP_TYPE_TOOL))
|
|
|
|
#define GIMP_TOOL_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GIMP_TYPE_TOOL, GimpToolClass))
|
|
|
|
#define GIMP_IS_TOOL_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_TOOL))
|
2000-12-29 15:22:01 +00:00
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
|
|
|
|
typedef struct _GimpToolClass GimpToolClass;
|
2000-12-29 15:22:01 +00:00
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
struct _GimpTool
|
1997-11-24 22:05:25 +00:00
|
|
|
{
|
2001-02-14 04:55:21 +00:00
|
|
|
GimpObject parent_instance;
|
1999-07-02 17:40:10 +00:00
|
|
|
|
2000-12-31 04:07:42 +00:00
|
|
|
ToolState state; /* state of tool activity */
|
|
|
|
gint paused_count; /* paused control count */
|
|
|
|
gboolean scroll_lock; /* allow scrolling or not */
|
|
|
|
gboolean auto_snap_to; /* snap to guides automatically */
|
1999-07-02 17:40:10 +00:00
|
|
|
|
2000-12-31 04:07:42 +00:00
|
|
|
gboolean preserve; /* Preserve this tool across drawable changes */
|
|
|
|
GDisplay *gdisp; /* pointer to currently active gdisp */
|
|
|
|
GimpDrawable *drawable; /* pointer to the tool's current drawable */
|
1999-07-02 17:40:10 +00:00
|
|
|
|
2000-12-31 04:07:42 +00:00
|
|
|
gboolean toggled; /* Bad hack to let the paint_core show the
|
|
|
|
* right toggle cursors
|
|
|
|
*/
|
2001-02-21 12:18:09 +00:00
|
|
|
PaintCore *paintcore;
|
1997-11-24 22:05:25 +00:00
|
|
|
};
|
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
struct _GimpToolClass
|
1997-11-24 22:05:25 +00:00
|
|
|
{
|
2001-02-14 04:55:21 +00:00
|
|
|
GimpObjectClass parent_class;
|
|
|
|
|
|
|
|
/* stuff to be filled in by child classes */
|
|
|
|
|
2001-02-21 12:18:09 +00:00
|
|
|
/* FIXME: most of this stuff must go away */
|
1999-04-12 17:55:06 +00:00
|
|
|
ToolOptions *tool_options;
|
1999-04-08 22:25:54 +00:00
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
gchar *pdb_string;
|
|
|
|
|
2000-11-18 00:25:42 +00:00
|
|
|
gchar *tool_name;
|
1998-06-21 20:17:21 +00:00
|
|
|
|
2000-11-18 00:25:42 +00:00
|
|
|
gchar *menu_path;
|
|
|
|
gchar *menu_accel;
|
1998-06-21 20:17:21 +00:00
|
|
|
|
2000-11-18 00:25:42 +00:00
|
|
|
gchar **icon_data;
|
|
|
|
GdkPixmap *icon_pixmap;
|
|
|
|
GdkBitmap *icon_mask;
|
1998-06-21 20:17:21 +00:00
|
|
|
|
2000-11-18 00:25:42 +00:00
|
|
|
gchar *tool_desc;
|
2001-02-14 04:55:21 +00:00
|
|
|
const gchar *help_data;
|
1998-06-21 20:17:21 +00:00
|
|
|
|
2000-11-18 00:25:42 +00:00
|
|
|
ToolType tool_id;
|
1998-06-21 20:17:21 +00:00
|
|
|
|
2000-12-31 04:07:42 +00:00
|
|
|
GtkWidget *tool_widget;
|
1999-07-02 17:40:10 +00:00
|
|
|
|
|
|
|
GimpContext *tool_context;
|
2000-06-09 12:31:19 +00:00
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
BitmapCursor *tool_cursor;
|
|
|
|
BitmapCursor *toggle_cursor;
|
2001-02-21 12:18:09 +00:00
|
|
|
|
|
|
|
|
|
|
|
void (* initialize) (GimpTool *tool,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void (* control) (GimpTool *tool,
|
|
|
|
ToolAction action,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void (* button_press) (GimpTool *tool,
|
|
|
|
GdkEventButton *bevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void (* button_release) (GimpTool *tool,
|
|
|
|
GdkEventButton *bevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void (* motion) (GimpTool *tool,
|
|
|
|
GdkEventMotion *mevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void (* arrow_key) (GimpTool *tool,
|
|
|
|
GdkEventKey *kevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void (* modifier_key) (GimpTool *tool,
|
|
|
|
GdkEventKey *kevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void (* cursor_update) (GimpTool *tool,
|
|
|
|
GdkEventMotion *mevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void (* oper_update) (GimpTool *tool,
|
|
|
|
GdkEventMotion *mevent,
|
|
|
|
GDisplay *gdisp);
|
2001-02-14 04:55:21 +00:00
|
|
|
};
|
2000-12-31 04:07:42 +00:00
|
|
|
|
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
/* Function declarations */
|
1997-11-24 22:05:25 +00:00
|
|
|
|
2001-02-21 12:18:09 +00:00
|
|
|
GtkType gimp_tool_get_type (void);
|
|
|
|
|
|
|
|
void gimp_tool_initialize (GimpTool *tool,
|
|
|
|
GDisplay *gdisplay);
|
|
|
|
void gimp_tool_control (GimpTool *tool,
|
|
|
|
ToolAction action,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void gimp_tool_button_press (GimpTool *tool,
|
|
|
|
GdkEventButton *bevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void gimp_tool_button_release (GimpTool *tool,
|
|
|
|
GdkEventButton *bevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void gimp_tool_motion (GimpTool *tool,
|
|
|
|
GdkEventMotion *mevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void gimp_tool_arrow_key (GimpTool *tool,
|
|
|
|
GdkEventKey *kevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void gimp_tool_modifier_key (GimpTool *tool,
|
|
|
|
GdkEventKey *kevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void gimp_tool_cursor_update (GimpTool *tool,
|
|
|
|
GdkEventMotion *mevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
void gimp_tool_oper_update (GimpTool *tool,
|
|
|
|
GdkEventMotion *mevent,
|
|
|
|
GDisplay *gdisp);
|
|
|
|
|
|
|
|
|
|
|
|
|
1999-04-08 22:25:54 +00:00
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
gchar * tool_get_PDB_string (GimpTool *tool);
|
1997-11-24 22:05:25 +00:00
|
|
|
|
2001-02-21 12:18:09 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
gchar * gimp_tool_get_help_data (GimpTool *tool);
|
|
|
|
void gimp_tool_help_func (const gchar *help_data);
|
|
|
|
|
2000-12-31 04:07:42 +00:00
|
|
|
/* don't unref these pixmaps, they are static! */
|
2001-02-14 04:55:21 +00:00
|
|
|
GdkPixmap * gimp_tool_get_pixmap (GimpToolClass *tool);
|
|
|
|
GdkBitmap * gimp_tool_get_mask (GimpToolClass *tool);
|
2000-12-31 04:07:42 +00:00
|
|
|
|
2001-02-21 12:18:09 +00:00
|
|
|
void gimp_tool_show_options (GimpTool *);
|
|
|
|
|
2000-02-08 23:45:20 +00:00
|
|
|
|
2001-02-14 04:55:21 +00:00
|
|
|
#endif /* __TOOL_H__ */
|