Gimp/app/tools/gimptool.h
Michael Natterer 868b8afbff Added new tool API for modifier key events while the tool is active and
2006-09-12  Michael Natterer  <mitch@gimp.org>

	Added new tool API for modifier key events while the tool
	is active and implement it in the rect select and crop tools.
	Fixes bug #316156 and bug #355302.

	* app/tools/gimptool.[ch]: added GimpTool::active_modifier_key()
	and public function gimp_tool_set_active_motifier_state(). Remember
	the active_state at button_press and reset it on button_release.
	Ignore releases of modifiers that were pressed at button_press (but
	only ignore them once).

	* app/tools/tool_manager.[ch]: added wrapper
	tool_manager_active_modifier_state_active().

	* app/display/gimpdisplayshell-callbacks.c
	(gimp_display_shell_events): return FALSE for all modifiers even
	when mouse button 1 is pressed.

	(gimp_display_shell_canvas_tool_events): when bouse button 1 is
	pressed *and* the tool is active, dispatch the new active_modifier
	events to tools.

	* app/tools/gimpcroptool.c
	* app/tools/gimprectangleselecttool.c
	* app/tools/gimprectangletool.[ch]: implement active_modifier_key()
	instead of modifier_key().
2006-09-12 18:41:09 +00:00

202 lines
10 KiB
C

/* The GIMP -- an image manipulation program
* Copyright (C) 1995-2002 Spencer Kimball, Peter Mattis, and others
*
* 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
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __GIMP_TOOL_H__
#define __GIMP_TOOL_H__
#include "core/gimpobject.h"
#define GIMP_TYPE_TOOL (gimp_tool_get_type ())
#define GIMP_TOOL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_TOOL, GimpTool))
#define GIMP_TOOL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_TOOL, GimpToolClass))
#define GIMP_IS_TOOL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_TOOL))
#define GIMP_IS_TOOL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_TOOL))
#define GIMP_TOOL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_TOOL, GimpToolClass))
#define GIMP_TOOL_GET_OPTIONS(t) (gimp_tool_get_options (GIMP_TOOL (t)))
typedef struct _GimpToolClass GimpToolClass;
struct _GimpTool
{
GimpObject parent_instance;
GimpToolInfo *tool_info;
gint ID; /* unique tool ID */
GimpToolControl *control;
GimpDisplay *display; /* pointer to currently active display */
GimpDrawable *drawable; /* pointer to the tool's current drawable */
/* focus_display and [active_]modifier_state are *private* state of
* gimp_tool_set_focus_display() and
* gimp_tool_set_[active_]modifier_state().
* ignore them in tool implementations, they don't exist!
*/
GimpDisplay *focus_display;
GdkModifierType modifier_state;
GdkModifierType button_press_state;
GdkModifierType active_modifier_state;
};
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);
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,
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);
};
GType gimp_tool_get_type (void) G_GNUC_CONST;
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);
gboolean gimp_tool_key_press (GimpTool *tool,
GdkEventKey *kevent,
GimpDisplay *display);
void gimp_tool_set_focus_display (GimpTool *tool,
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 *message);
void gimp_tool_push_status_coords (GimpTool *tool,
GimpDisplay *display,
const gchar *title,
gdouble x,
const gchar *separator,
gdouble y);
void gimp_tool_push_status_length (GimpTool *tool,
GimpDisplay *display,
const gchar *title,
GimpOrientationType axis,
gdouble value);
void gimp_tool_replace_status (GimpTool *tool,
GimpDisplay *display,
const gchar *message);
void gimp_tool_pop_status (GimpTool *tool,
GimpDisplay *display);
void gimp_tool_set_cursor (GimpTool *tool,
GimpDisplay *display,
GimpCursorType cursor,
GimpToolCursorType tool_cursor,
GimpCursorModifier modifier);
#endif /* __GIMP_TOOL_H__ */