gimptextbuffer.h 10.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * GimpTextBuffer
 * Copyright (C) 2010  Michael Natterer <mitch@gimp.org>
 *
 * 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 3 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
18
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
 */

#ifndef __GIMP_TEXT_BUFFER_H__
#define __GIMP_TEXT_BUFFER_H__


#define GIMP_TYPE_TEXT_BUFFER            (gimp_text_buffer_get_type ())
#define GIMP_TEXT_BUFFER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_TEXT_BUFFER, GimpTextBuffer))
#define GIMP_IS_TEXT_BUFFER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_TEXT_BUFFER))
#define GIMP_TEXT_BUFFER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_TEXT_BUFFER, GimpTextBufferClass))
#define GIMP_IS_TEXT_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_TEXT_BUFFER))


typedef struct _GimpTextBufferClass  GimpTextBufferClass;

struct _GimpTextBuffer
{
  GtkTextBuffer  parent_instance;
37 38 39 40 41 42

  GtkTextTag    *bold_tag;
  GtkTextTag    *italic_tag;
  GtkTextTag    *underline_tag;
  GtkTextTag    *strikethrough_tag;

43
  GList         *size_tags;
44
  GList         *baseline_tags;
45
  GList         *kerning_tags;
46
  GList         *font_tags;
47
  GList         *color_tags;
48

49
  GtkTextTag    *preedit_underline_tag;
50 51
  GList         *preedit_color_tags;
  GList         *preedit_bg_color_tags;
52

53
  gboolean       insert_tags_set;
54 55
  GList         *insert_tags;
  GList         *remove_tags;
56

57
  GdkAtom        markup_atom;
58 59 60 61 62
};

struct _GimpTextBufferClass
{
  GtkTextBufferClass  parent_class;
63 64 65

  void (* color_applied) (GimpTextBuffer *buffer,
                          const GimpRGB  *color);
66 67 68
};


69
GType            gimp_text_buffer_get_type          (void) G_GNUC_CONST;
70

71
GimpTextBuffer * gimp_text_buffer_new               (void);
72

73 74 75 76 77 78 79 80
void             gimp_text_buffer_set_text          (GimpTextBuffer    *buffer,
                                                     const gchar       *text);
gchar          * gimp_text_buffer_get_text          (GimpTextBuffer    *buffer);

void             gimp_text_buffer_set_markup        (GimpTextBuffer    *buffer,
                                                     const gchar       *markup);
gchar          * gimp_text_buffer_get_markup        (GimpTextBuffer    *buffer);

81 82
gboolean         gimp_text_buffer_has_markup        (GimpTextBuffer    *buffer);

83 84 85
GtkTextTag     * gimp_text_buffer_get_iter_size     (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *iter,
                                                     gint              *size);
86 87
GtkTextTag     * gimp_text_buffer_get_size_tag      (GimpTextBuffer    *buffer,
                                                     gint               size);
88 89 90 91 92 93 94 95 96
void             gimp_text_buffer_set_size          (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
                                                     gint               size);
void             gimp_text_buffer_change_size       (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
                                                     gint               amount);

97
GtkTextTag     * gimp_text_buffer_get_iter_baseline (GimpTextBuffer    *buffer,
98
                                                     const GtkTextIter *iter,
99
                                                     gint              *baseline);
100 101 102 103
void             gimp_text_buffer_set_baseline      (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
                                                     gint               count);
104 105 106 107
void             gimp_text_buffer_change_baseline   (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
                                                     gint               count);
108

109
GtkTextTag     * gimp_text_buffer_get_iter_kerning  (GimpTextBuffer    *buffer,
110
                                                     const GtkTextIter *iter,
111
                                                     gint              *kerning);
112 113 114 115
void             gimp_text_buffer_set_kerning       (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
                                                     gint               count);
116
void             gimp_text_buffer_change_kerning    (GimpTextBuffer    *buffer,
117 118 119 120
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
                                                     gint               count);

121
GtkTextTag     * gimp_text_buffer_get_iter_font     (GimpTextBuffer    *buffer,
122
                                                     const GtkTextIter *iter,
123
                                                     gchar            **font);
124 125
GtkTextTag     * gimp_text_buffer_get_font_tag      (GimpTextBuffer    *buffer,
                                                     const gchar       *font);
126 127 128 129 130
void             gimp_text_buffer_set_font          (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
                                                     const gchar       *font);

131 132 133
GtkTextTag     * gimp_text_buffer_get_iter_color    (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *iter,
                                                     GimpRGB           *color);
134 135
GtkTextTag     * gimp_text_buffer_get_color_tag     (GimpTextBuffer    *buffer,
                                                     const GimpRGB     *color);
136 137 138 139 140
void             gimp_text_buffer_set_color         (GimpTextBuffer    *buffer,
                                                     const GtkTextIter *start,
                                                     const GtkTextIter *end,
                                                     const GimpRGB     *color);

141 142 143 144 145 146 147 148 149 150 151 152
GtkTextTag * gimp_text_buffer_get_preedit_color_tag    (GimpTextBuffer    *buffer,
                                                        const GimpRGB     *color);
void         gimp_text_buffer_set_preedit_color        (GimpTextBuffer    *buffer,
                                                        const GtkTextIter *start,
                                                        const GtkTextIter *end,
                                                        const GimpRGB     *color);
GtkTextTag * gimp_text_buffer_get_preedit_bg_color_tag (GimpTextBuffer    *buffer,
                                                        const GimpRGB     *color);
void         gimp_text_buffer_set_preedit_bg_color     (GimpTextBuffer    *buffer,
                                                        const GtkTextIter *start,
                                                        const GtkTextIter *end,
                                                        const GimpRGB     *color);
153

154 155 156 157 158 159 160 161 162 163
const gchar    * gimp_text_buffer_tag_to_name       (GimpTextBuffer    *buffer,
                                                     GtkTextTag        *tag,
                                                     const gchar      **attribute,
                                                     gchar            **value);
GtkTextTag     * gimp_text_buffer_name_to_tag       (GimpTextBuffer    *buffer,
                                                     const gchar       *name,
                                                     const gchar       *attribute,
                                                     const gchar       *value);

void             gimp_text_buffer_set_insert_tags   (GimpTextBuffer    *buffer,
164 165
                                                     GList             *insert_tags,
                                                     GList             *remove_tags);
166 167 168 169 170
void             gimp_text_buffer_clear_insert_tags (GimpTextBuffer    *buffer);
void             gimp_text_buffer_insert            (GimpTextBuffer    *buffer,
                                                     const gchar       *text);

gint             gimp_text_buffer_get_iter_index    (GimpTextBuffer    *buffer,
171 172 173 174 175 176
                                                     GtkTextIter       *iter,
                                                     gboolean           layout_index);
void             gimp_text_buffer_get_iter_at_index (GimpTextBuffer    *buffer,
                                                     GtkTextIter       *iter,
                                                     gint               index,
                                                     gboolean           layout_index);
177 178

gboolean         gimp_text_buffer_load              (GimpTextBuffer    *buffer,
179
                                                     GFile             *file,
180 181
                                                     GError           **error);
gboolean         gimp_text_buffer_save              (GimpTextBuffer    *buffer,
182
                                                     GFile             *file,
183 184
                                                     gboolean           selection_only,
                                                     GError           **error);
185 186 187


#endif /* __GIMP_TEXT_BUFFER_H__ */