gimpfiltertool.h 5.61 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
  gboolean               has_settings;
55
  GFile                 *settings_folder;
56 57 58
  gchar                 *import_dialog_title;
  gchar                 *export_dialog_title;

59
  GimpDrawableFilter    *filter;
60

61
  GimpGuide             *preview_guide;
62

63
  /* dialog */
64
  gboolean               overlay;
65
  GimpToolGui           *gui;
66
  GtkWidget             *settings_box;
67
  GtkWidget             *region_combo;
68
  GtkWidget             *active_picker;
Michael Natterer's avatar
Michael Natterer committed
69 70
};

71
struct _GimpFilterToolClass
Michael Natterer's avatar
Michael Natterer committed
72
{
73
  GimpColorToolClass  parent_class;
74 75

  /* virtual functions */
76
  gchar     * (* get_operation)   (GimpFilterTool    *filter_tool,
77 78 79 80
                                   gchar            **title,
                                   gchar            **description,
                                   gchar            **undo_desc,
                                   gchar            **icon_name,
81 82 83 84 85
                                   gchar            **help_id,
                                   gboolean          *has_settings,
                                   gchar            **settings_folder,
                                   gchar            **import_dialog_title,
                                   gchar            **export_dialog_title);
86 87
  void        (* dialog)          (GimpFilterTool    *filter_tool);
  void        (* reset)           (GimpFilterTool    *filter_tool);
88 89
  void        (* set_config)      (GimpFilterTool    *filter_tool,
                                   GimpConfig        *config);
90

91
  gboolean    (* settings_import) (GimpFilterTool    *filter_tool,
92
                                   GInputStream      *input,
93
                                   GError           **error);
94
  gboolean    (* settings_export) (GimpFilterTool    *filter_tool,
95
                                   GOutputStream     *output,
96
                                   GError           **error);
97

98
  void        (* color_picked)    (GimpFilterTool    *filter_tool,
99
                                   gpointer           identifier,
100 101
                                   gdouble            x,
                                   gdouble            y,
102 103
                                   const Babl        *sample_format,
                                   const GimpRGB     *color);
Michael Natterer's avatar
Michael Natterer committed
104 105 106
};


107
GType       gimp_filter_tool_get_type         (void) G_GNUC_CONST;
108

109
void        gimp_filter_tool_get_operation    (GimpFilterTool   *filter_tool);
110

111 112 113
void        gimp_filter_tool_set_has_settings (GimpFilterTool   *filter_tool,
                                               gboolean          has_settings);

114 115 116
void        gimp_filter_tool_set_config       (GimpFilterTool   *filter_tool,
                                               GimpConfig       *config);

117 118 119
void        gimp_filter_tool_edit_as          (GimpFilterTool   *filter_tool,
                                               const gchar      *new_tool_id,
                                               GimpConfig       *config);
120

121 122 123
gboolean    gimp_filter_tool_on_guide         (GimpFilterTool   *filter_tool,
                                               const GimpCoords *coords,
                                               GimpDisplay      *display);
124

125
GtkWidget * gimp_filter_tool_dialog_get_vbox  (GimpFilterTool   *filter_tool);
126

127 128 129
GtkWidget * gimp_filter_tool_add_color_picker (GimpFilterTool   *filter_tool,
                                               gpointer          identifier,
                                               const gchar      *icon_name,
130 131
                                               const gchar      *tooltip,
                                               gboolean          pick_abyss);
132

Michael Natterer's avatar
Michael Natterer committed
133

134
#endif /* __GIMP_FILTER_TOOL_H__ */