gimp/app/tools/gimptoolcontrol.c
Michael Natterer a74a8997b4 devel-docs/Makefile.am new file documenting the core's include policy.
2002-05-03  Michael Natterer  <mitch@gimp.org>

	* devel-docs/Makefile.am
	* devel-docs/includes.txt: new file documenting the core's
	include policy.

	* HACKING: mention it here.

	* libgimptool/gimptooltypes.h: removed GimpToolOptions here.

	* app/core/core-types.h: and added it here. This is a temp hack
	needed because GimpToolInfo needs to know the GimpToolOptions
	type.

	* libgimpproxy/gimpproxytypes.h: regenerated.

	* libgimptool/gimptoolmodule.h: don't include gimptooltypes.h here...
	* libgimptool/gimptoolmodule.c: ...but here.

	* app/config/gimpconfig-params.c: include "libgimpbase/gimpbase.h"
	entirely, not single files from it.

	* app/core/gimp.c
	* app/core/gimpcontext.c
	* app/core/gimpcoreconfig.c
	* app/core/gimpdatafactory.c
	* app/core/gimpdocuments.c
	* app/core/gimpdrawable-blend.c
	* app/core/gimpdrawable-bucket-fill.c
	* app/core/gimpdrawable-offset.c
	* app/core/gimpdrawable-transform.c
	* app/core/gimpdrawable.c
	* app/core/gimpedit.c
	* app/core/gimpimage-convert.c
	* app/core/gimpimage-crop.c
	* app/core/gimpimage-duplicate.c
	* app/core/gimpimage-guides.c
	* app/core/gimpimage-mask.c
	* app/core/gimpimage-merge.c
	* app/core/gimpimage-new.c
	* app/core/gimpimage-projection.c
	* app/core/gimpimage-qmask.c
	* app/core/gimpimage-resize.c
	* app/core/gimpimage-scale.c
	* app/core/gimpimage.c
	* app/core/gimpitem.c
	* app/core/gimpmodules.c
	* app/core/gimppaintinfo.c
	* app/core/gimpparasite.c
	* app/core/gimppreviewcache.c
	* app/core/gimptoolinfo.c
	* app/core/gimpunit.c: include "core-types.h" and no other types file.

	* app/display/gimpdisplay.c
	* app/display/gimpdisplayshell-callbacks.c
	* app/display/gimpdisplayshell.c: include "tools/tools-types.h"
	instead of "libgimptool/gimptooltypes.h", warn about inclusion
	on "gui/gui-types.h"

	* app/file/file-open.c
	* app/file/file-save.c: don't include "libgimptool/gimptooltypes.h".

	* app/gui/about-dialog.c
	* app/gui/brush-select.c
	* app/gui/brushes-commands.c
	* app/gui/color-select.c
	* app/gui/data-commands.c
	* app/gui/device-status-dialog.c
	* app/gui/dialogs.c
	* app/gui/gradients-commands.c
	* app/gui/help-commands.c
	* app/gui/info-window.c
	* app/gui/palettes-commands.c
	* app/gui/patterns-commands.c
	* app/gui/resize-dialog.c
	* app/gui/tips-dialog.c
	* app/gui/tool-options-dialog.c: include "gui-types.h" and no
	other types file.

	* app/paint/gimpairbrush.c
	* app/paint/gimpclone.c
	* app/paint/gimpconvolve.c
	* app/paint/gimpdodgeburn.c
	* app/paint/gimperaser.c
	* app/paint/gimppaintbrush.c
	* app/paint/gimppaintcore-stroke.c
	* app/paint/gimppaintcore.c
	* app/paint/gimppaintoptions.c
	* app/paint/gimppencil.c
	* app/paint/gimpsmudge.c
	* app/paint/paint.c: include "paint-types.h" and no other types file.

	* app/pdb/pdb-types.h: don't include "libgimptool/gimptooltypes.h".

	* app/plug-in/plug-in-progress.c: warn about inclusion of
	"display/display-types.h"

	* app/tools/tools-types.h: include "libgimptool/gimptooltypes.h".

	* app/tools/gimpairbrushtool.c
	* app/tools/gimpbezierselecttool.c
	* app/tools/gimpblendtool.c
	* app/tools/gimpbrightnesscontrasttool.c
	* app/tools/gimpbucketfilltool.c
	* app/tools/gimpbycolorselecttool.c
	* app/tools/gimpclonetool.c
	* app/tools/gimpcolorbalancetool.c
	* app/tools/gimpcolorpickertool.c
	* app/tools/gimpconvolvetool.c
	* app/tools/gimpcroptool.c
	* app/tools/gimpcurvestool.c
	* app/tools/gimpdodgeburntool.c
	* app/tools/gimpdrawtool.c
	* app/tools/gimpeditselectiontool.c
	* app/tools/gimpellipseselecttool.c
	* app/tools/gimperasertool.c
	* app/tools/gimpfliptool.c
	* app/tools/gimpfreeselecttool.c
	* app/tools/gimpfuzzyselecttool.c
	* app/tools/gimphistogramtool.c
	* app/tools/gimphuesaturationtool.c
	* app/tools/gimpinktool.c
	* app/tools/gimplevelstool.c
	* app/tools/gimpmagnifytool.c
	* app/tools/gimpmeasuretool.c
	* app/tools/gimpmovetool.c
	* app/tools/gimppaintbrushtool.c
	* app/tools/gimppainttool.c
	* app/tools/gimppathtool.c
	* app/tools/gimppenciltool.c
	* app/tools/gimpperspectivetool.c
	* app/tools/gimpposterizetool.c
	* app/tools/gimprectselecttool.c
	* app/tools/gimprotatetool.c
	* app/tools/gimpscaletool.c
	* app/tools/gimpselectiontool.c
	* app/tools/gimpsheartool.c
	* app/tools/gimpsmudgetool.c
	* app/tools/gimptexttool.c
	* app/tools/gimpthresholdtool.c
	* app/tools/gimptoolcontrol.c
	* app/tools/gimptoolcontrol.h
	* app/tools/gimptransformtool.c
	* app/tools/gimpvectortool.c
	* app/tools/tools.c: include "tools-types.h" and no other types file,
	warn about inclusion of "gui/gui-types.h".

	* app/widgets/gimpcolorpanel.c
	* app/widgets/gimptoolbox-color-area.c: warn about inclusion of
	"gui/gui-types.h".

	* app/xcf/xcf-load.c
	* app/xcf/xcf.c: don't include "libgimptool/gimptooltypes.h".

	Split tool-safe-mode up in two files, one including libgimpproxy,
	one libgimp.

	* plug-ins/tools/Makefile.am
	* plug-ins/tools/tool-safe-mode-plug-in.[ch]: new files including
	libgimp/ stuff only.

	* plug-ins/tools/tool-safe-mode.[ch]: include libgimpproxy/ and
	libgimptool/ but don't include libgimp/ because of conflicting
	declarations.

	Unrelated:

	* app/tools/gimpclonetool.c: create the clone core so we don't crash.

	* app/gui/file-open-dialog.c: changed the way we create previews
	so that only out-of-date previews are created on a click in the
	preview area. Unconditional creation can still be forced by
	<Ctrl>+click. Changed the tooltip to document this.
2002-05-03 12:45:22 +00:00

349 lines
8.9 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.
*/
#include "config.h"
#include <gtk/gtk.h>
#include "tools-types.h"
#include "gimptoolcontrol.h"
static void gimp_tool_control_class_init (GimpToolControlClass *klass);
static void gimp_tool_control_init (GimpToolControl *tool);
static GimpObjectClass *parent_class = NULL;
GType
gimp_tool_control_get_type (void)
{
static GType tool_control_type = 0;
if (! tool_control_type)
{
static const GTypeInfo tool_control_info =
{
sizeof (GimpToolControlClass),
(GBaseInitFunc) NULL,
(GBaseFinalizeFunc) NULL,
(GClassInitFunc) gimp_tool_control_class_init,
NULL, /* class_finalize */
NULL, /* class_data */
sizeof (GimpToolControl),
0, /* n_preallocs */
(GInstanceInitFunc) gimp_tool_control_init,
};
tool_control_type = g_type_register_static (GIMP_TYPE_OBJECT,
"GimpToolControl",
&tool_control_info, 0);
}
return tool_control_type;
}
static void
gimp_tool_control_class_init (GimpToolControlClass *klass)
{
parent_class = g_type_class_peek_parent (klass);
}
static void
gimp_tool_control_init (GimpToolControl *control)
{
control->state = INACTIVE;
control->paused_count = 0;
control->toggled = FALSE;
control->scroll_lock = FALSE; /* Allow scrolling */
control->auto_snap_to = TRUE; /* Snap to guides */
control->preserve = TRUE; /* Preserve across drawable change */
control->handle_empty_image = FALSE; /* Require active drawable */
control->motion_mode = GIMP_MOTION_MODE_HINT; /* Use MOTION_HINT compression */
control->cursor = GIMP_MOUSE_CURSOR;
control->tool_cursor = GIMP_TOOL_CURSOR_NONE;
control->cursor_modifier = GIMP_CURSOR_MODIFIER_NONE;
control->toggle_cursor = GIMP_MOUSE_CURSOR;
control->toggle_tool_cursor = GIMP_TOOL_CURSOR_NONE;
control->toggle_cursor_modifier = GIMP_CURSOR_MODIFIER_NONE;
}
void
gimp_tool_control_pause (GimpToolControl *control)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
/* control->state = PAUSED ? */
control->paused_count++;
}
void
gimp_tool_control_resume (GimpToolControl *control)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->paused_count--;
}
gboolean
gimp_tool_control_is_paused (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->paused_count > 0;
}
void
gimp_tool_control_activate (GimpToolControl *control)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->state = ACTIVE;
}
void
gimp_tool_control_halt (GimpToolControl *control)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->state = INACTIVE;
control->paused_count = 0;
}
gboolean
gimp_tool_control_is_active (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->state == ACTIVE;
}
void
gimp_tool_control_set_toggle (GimpToolControl *control,
gboolean toggled)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->toggled = toggled;
}
void
gimp_tool_control_set_handles_empty_image (GimpToolControl *control,
gboolean handle_empty)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->handle_empty_image = handle_empty;
}
void
gimp_tool_control_set_snap_to (GimpToolControl *control,
gboolean snap_to)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->auto_snap_to = snap_to;
}
void
gimp_tool_control_set_motion_mode (GimpToolControl *control,
GimpMotionMode motion_mode)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->motion_mode = motion_mode;
}
void
gimp_tool_control_set_preserve (GimpToolControl *control,
gboolean preserve)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->preserve = preserve;
}
void
gimp_tool_control_set_cursor (GimpToolControl *control,
GdkCursorType cursor)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->cursor = cursor;
}
void
gimp_tool_control_set_tool_cursor (GimpToolControl *control,
GimpToolCursorType cursor)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->tool_cursor = cursor;
}
void
gimp_tool_control_set_cursor_modifier (GimpToolControl *control,
GimpCursorModifier cmodifier)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->cursor_modifier = cmodifier;
}
void
gimp_tool_control_set_toggle_cursor (GimpToolControl *control,
GdkCursorType cursor)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->toggle_cursor = cursor;
}
void
gimp_tool_control_set_toggle_tool_cursor (GimpToolControl *control,
GimpToolCursorType cursor)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->toggle_tool_cursor = cursor;
}
void
gimp_tool_control_set_toggle_cursor_modifier (GimpToolControl *control,
GimpCursorModifier cmodifier)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->toggle_cursor_modifier = cmodifier;
}
void
gimp_tool_control_set_scroll_lock (GimpToolControl *control,
gboolean scroll_lock)
{
g_return_if_fail(GIMP_IS_TOOL_CONTROL(control));
control->scroll_lock = scroll_lock;
}
GimpMotionMode
gimp_tool_control_motion_mode (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), GIMP_MOTION_MODE_HINT);
return control->motion_mode;
}
gboolean
gimp_tool_control_handles_empty_image (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->handle_empty_image;
}
gboolean
gimp_tool_control_auto_snap_to (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->auto_snap_to;
}
gboolean
gimp_tool_control_preserve (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->preserve;
}
gboolean
gimp_tool_control_scroll_lock (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->scroll_lock;
}
gboolean
gimp_tool_control_is_toggled (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->toggled;
}
GdkCursorType
gimp_tool_control_get_cursor (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->cursor;
}
GdkCursorType
gimp_tool_control_get_toggle_cursor (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->toggle_cursor;
}
GimpToolCursorType
gimp_tool_control_get_tool_cursor (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->tool_cursor;
}
GimpToolCursorType
gimp_tool_control_get_toggle_tool_cursor (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->toggle_tool_cursor;
}
GimpCursorModifier
gimp_tool_control_get_cursor_modifier (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->cursor_modifier;
}
GimpCursorModifier
gimp_tool_control_get_toggle_cursor_modifier (GimpToolControl *control)
{
g_return_val_if_fail(GIMP_IS_TOOL_CONTROL(control), FALSE);
return control->toggle_cursor_modifier;
}