gimpfiltertool.h 6.23 KB
Newer Older
1
/* GIMP - The GNU Image Manipulation Program
Michael Natterer's avatar
Michael Natterer committed
2 3
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
4
 * This program is free software: you can redistribute it and/or modify
Michael Natterer's avatar
Michael Natterer committed
5
 * it under the terms of the GNU General Public License as published by
6
 * the Free Software Foundation; either version 3 of the License, or
Michael Natterer's avatar
Michael Natterer committed
7 8 9 10 11 12 13 14
 * (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
15
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
Michael Natterer's avatar
Michael Natterer committed
16 17
 */

18 19
#ifndef __GIMP_FILTER_TOOL_H__
#define __GIMP_FILTER_TOOL_H__
Michael Natterer's avatar
Michael Natterer committed
20 21


22
#include "gimpcolortool.h"
Michael Natterer's avatar
Michael Natterer committed
23 24


25 26 27 28 29 30
#define GIMP_TYPE_FILTER_TOOL            (gimp_filter_tool_get_type ())
#define GIMP_FILTER_TOOL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_FILTER_TOOL, GimpFilterTool))
#define GIMP_FILTER_TOOL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_FILTER_TOOL, GimpFilterToolClass))
#define GIMP_IS_FILTER_TOOL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_FILTER_TOOL))
#define GIMP_IS_FILTER_TOOL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_FILTER_TOOL))
#define GIMP_FILTER_TOOL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_FILTER_TOOL, GimpFilterToolClass))
Michael Natterer's avatar
Michael Natterer committed
31

32
#define GIMP_FILTER_TOOL_GET_OPTIONS(t)  (GIMP_FILTER_OPTIONS (gimp_tool_get_options (GIMP_TOOL (t))))
33

Michael Natterer's avatar
Michael Natterer committed
34

35
typedef struct _GimpFilterToolClass GimpFilterToolClass;
Michael Natterer's avatar
Michael Natterer committed
36

37
struct _GimpFilterTool
Michael Natterer's avatar
Michael Natterer committed
38
{
39
  GimpColorTool          parent_instance;
40

41 42 43
  GimpDrawable          *drawable;

  GeglNode              *operation;
44
  GObject               *config;
45
  GObject               *default_config;
46
  GimpContainer         *settings;
47 48 49

  gchar                 *title;
  gchar                 *description;
50
  gchar                 *undo_desc;
51 52
  gchar                 *icon_name;
  gchar                 *help_id;
53

54 55 56 57
  gboolean               has_settings;
  gchar                 *import_dialog_title;
  gchar                 *export_dialog_title;

58
  GimpDrawableFilter    *filter;
59

60
  GimpGuide             *preview_guide;
61

62 63 64
  gpointer               pick_identifier;
  gboolean               pick_abyss;

65
  /* dialog */
66
  gboolean               overlay;
67
  GimpToolGui           *gui;
68
  GtkWidget             *settings_box;
69
  GtkWidget             *region_combo;
70
  GtkWidget             *active_picker;
71 72 73 74

  /* widget */
  GimpToolWidget        *widget;
  GimpToolWidget        *grab_widget;
Michael Natterer's avatar
Michael Natterer committed
75 76
};

77
struct _GimpFilterToolClass
Michael Natterer's avatar
Michael Natterer committed
78
{
79
  GimpColorToolClass  parent_class;
80 81

  /* virtual functions */
82
  gchar     * (* get_operation)   (GimpFilterTool    *filter_tool,
83 84 85 86
                                   gchar            **title,
                                   gchar            **description,
                                   gchar            **undo_desc,
                                   gchar            **icon_name,
87 88 89 90
                                   gchar            **help_id,
                                   gboolean          *has_settings,
                                   gchar            **import_dialog_title,
                                   gchar            **export_dialog_title);
91 92
  void        (* dialog)          (GimpFilterTool    *filter_tool);
  void        (* reset)           (GimpFilterTool    *filter_tool);
93 94
  void        (* set_config)      (GimpFilterTool    *filter_tool,
                                   GimpConfig        *config);
95

96
  gboolean    (* settings_import) (GimpFilterTool    *filter_tool,
97
                                   GInputStream      *input,
98
                                   GError           **error);
99
  gboolean    (* settings_export) (GimpFilterTool    *filter_tool,
100
                                   GOutputStream     *output,
101
                                   GError           **error);
102

103
  void        (* color_picked)    (GimpFilterTool    *filter_tool,
104
                                   gpointer           identifier,
105 106
                                   gdouble            x,
                                   gdouble            y,
107 108
                                   const Babl        *sample_format,
                                   const GimpRGB     *color);
Michael Natterer's avatar
Michael Natterer committed
109 110 111
};


112
GType       gimp_filter_tool_get_type              (void) G_GNUC_CONST;
113

114
void        gimp_filter_tool_get_operation         (GimpFilterTool   *filter_tool);
115

116 117
void        gimp_filter_tool_set_has_settings      (GimpFilterTool   *filter_tool,
                                                    gboolean          has_settings);
118

119 120
void        gimp_filter_tool_set_config            (GimpFilterTool   *filter_tool,
                                                    GimpConfig       *config);
121

122 123 124
void        gimp_filter_tool_edit_as               (GimpFilterTool   *filter_tool,
                                                    const gchar      *new_tool_id,
                                                    GimpConfig       *config);
125

126 127 128
gboolean    gimp_filter_tool_on_guide              (GimpFilterTool   *filter_tool,
                                                    const GimpCoords *coords,
                                                    GimpDisplay      *display);
129

130
GtkWidget * gimp_filter_tool_dialog_get_vbox       (GimpFilterTool   *filter_tool);
131

132 133 134 135 136 137 138 139 140
void        gimp_filter_tool_enable_color_picking  (GimpFilterTool   *filter_tool,
                                                    gpointer          identifier,
                                                    gboolean          pick_abyss);
void        gimp_filter_tool_disable_color_picking (GimpFilterTool   *filter_tool);
GtkWidget * gimp_filter_tool_add_color_picker      (GimpFilterTool   *filter_tool,
                                                    gpointer          identifier,
                                                    const gchar      *icon_name,
                                                    const gchar      *tooltip,
                                                    gboolean          pick_abyss);
141 142
void        gimp_filter_tool_set_widget            (GimpFilterTool   *filter_tool,
                                                    GimpToolWidget   *widget);
143

Michael Natterer's avatar
Michael Natterer committed
144

145
#endif /* __GIMP_FILTER_TOOL_H__ */