1 /* gtktexttag.c - text tag object
3 * Copyright (c) 1992-1994 The Regents of the University of California.
4 * Copyright (c) 1994-1997 Sun Microsystems, Inc.
5 * Copyright (c) 2000 Red Hat, Inc.
6 * Tk -> Gtk port by Havoc Pennington <hp@redhat.com>
8 * This software is copyrighted by the Regents of the University of
9 * California, Sun Microsystems, Inc., and other parties. The
10 * following terms apply to all files associated with the software
11 * unless explicitly disclaimed in individual files.
13 * The authors hereby grant permission to use, copy, modify,
14 * distribute, and license this software and its documentation for any
15 * purpose, provided that existing copyright notices are retained in
16 * all copies and that this notice is included verbatim in any
17 * distributions. No written agreement, license, or royalty fee is
18 * required for any of the authorized uses. Modifications to this
19 * software may be copyrighted by their authors and need not follow
20 * the licensing terms described here, provided that the new terms are
21 * clearly indicated on the first page of each file where they apply.
23 * IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY
24 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
25 * DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION,
26 * OR ANY DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED
27 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 * THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
30 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
32 * NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS,
33 * AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
34 * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
36 * GOVERNMENT USE: If you are acquiring this software on behalf of the
37 * U.S. government, the Government shall have only "Restricted Rights"
38 * in the software and related documentation as defined in the Federal
39 * Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
40 * are acquiring the software on behalf of the Department of Defense,
41 * the software shall be classified as "Commercial Computer Software"
42 * and the Government shall have only "Restricted Rights" as defined
43 * in Clause 252.227-7013 (c) (1) of DFARs. Notwithstanding the
44 * foregoing, the authors grant the U.S. Government and others acting
45 * in its behalf permission to use and distribute the software in
46 * accordance with the terms specified in this license.
50 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
51 #error "Only <gtk/gtk.h> can be included directly."
54 #ifndef __GTK_TEXT_TAG_H__
55 #define __GTK_TEXT_TAG_H__
59 #include <gtk/gtkenums.h>
64 typedef struct _GtkTextIter GtkTextIter;
65 typedef struct _GtkTextTagTable GtkTextTagTable;
67 typedef struct _GtkTextAttributes GtkTextAttributes;
69 #define GTK_TYPE_TEXT_TAG (gtk_text_tag_get_type ())
70 #define GTK_TEXT_TAG(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_TAG, GtkTextTag))
71 #define GTK_TEXT_TAG_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_TAG, GtkTextTagClass))
72 #define GTK_IS_TEXT_TAG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_TAG))
73 #define GTK_IS_TEXT_TAG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_TAG))
74 #define GTK_TEXT_TAG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_TAG, GtkTextTagClass))
76 #define GTK_TYPE_TEXT_ATTRIBUTES (gtk_text_attributes_get_type ())
78 typedef struct _GtkTextTag GtkTextTag;
79 typedef struct _GtkTextTagPrivate GtkTextTagPrivate;
80 typedef struct _GtkTextTagClass GtkTextTagClass;
84 GObject parent_instance;
86 GtkTextTagPrivate *priv;
89 struct _GtkTextTagClass
91 GObjectClass parent_class;
93 gboolean (* event) (GtkTextTag *tag,
94 GObject *event_object, /* widget, canvas item, whatever */
95 GdkEvent *event, /* the event itself */
96 const GtkTextIter *iter); /* location of event in buffer */
98 /* Padding for future expansion */
99 void (*_gtk_reserved1) (void);
100 void (*_gtk_reserved2) (void);
101 void (*_gtk_reserved3) (void);
102 void (*_gtk_reserved4) (void);
105 GType gtk_text_tag_get_type (void) G_GNUC_CONST;
106 GtkTextTag *gtk_text_tag_new (const gchar *name);
107 gint gtk_text_tag_get_priority (GtkTextTag *tag);
108 void gtk_text_tag_set_priority (GtkTextTag *tag,
110 gboolean gtk_text_tag_event (GtkTextTag *tag,
111 GObject *event_object,
113 const GtkTextIter *iter);
116 * Style object created by folding a set of tags together
119 typedef struct _GtkTextAppearance GtkTextAppearance;
121 struct _GtkTextAppearance
127 /* super/subscript rise, can be negative */
131 /* I'm not sure this can really be used without breaking some things
132 * an app might do :-/
137 guint underline : 4; /* PangoUnderline */
138 guint strikethrough : 1;
140 /* Whether to use background-related values; this is irrelevant for
141 * the values struct when in a tag, but is used for the composite
142 * values struct; it's true if any of the tags being composited
143 * had background stuff set.
147 /* These are only used when we are actually laying out and rendering
148 * a paragraph; not when a GtkTextAppearance is part of a
151 guint inside_selection : 1;
161 struct _GtkTextAttributes
167 GtkTextAppearance appearance;
169 GtkJustification justification;
170 GtkTextDirection direction;
172 /* Individual chunks of this can be set/unset as a group */
173 PangoFontDescription *font;
183 gint pixels_above_lines;
185 gint pixels_below_lines;
187 gint pixels_inside_wrap;
191 GtkWrapMode wrap_mode; /* How to handle wrap-around for this tag.
192 * Must be GTK_WRAPMODE_CHAR,
193 * GTK_WRAPMODE_NONE, GTK_WRAPMODE_WORD
196 PangoLanguage *language;
199 GdkColor *pg_bg_color;
205 /* Background is fit to full line height rather than
206 * baseline +/- ascent/descent (font height)
208 guint bg_full_height : 1;
210 /* can edit this text */
220 GtkTextAttributes* gtk_text_attributes_new (void);
221 GtkTextAttributes* gtk_text_attributes_copy (GtkTextAttributes *src);
222 void gtk_text_attributes_copy_values (GtkTextAttributes *src,
223 GtkTextAttributes *dest);
224 void gtk_text_attributes_unref (GtkTextAttributes *values);
225 GtkTextAttributes *gtk_text_attributes_ref (GtkTextAttributes *values);
227 GType gtk_text_attributes_get_type (void) G_GNUC_CONST;