Pileus Git - ~andy/gtk/blob - gtk/gtktexttag.h

   1 /* gtktexttag.c - text tag object
   2  *
   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>
   7  *
   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.
  12  *
  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.
  22  *
  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.
  28  *
  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.
  35  *
  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.
  47  *
  48  */
  49
  50 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  51 #error "Only <gtk/gtk.h> can be included directly."
  52 #endif
  53
  54 #ifndef __GTK_TEXT_TAG_H__
  55 #define __GTK_TEXT_TAG_H__
  56
  57 #include <glib-object.h>
  58 #include <gdk/gdk.h>
  59 #include <gtk/gtkenums.h>
  60
  61 /* Not needed, retained for compatibility -Yosh */
  62 #include <gtk/gtkobject.h>
  63
  64 G_BEGIN_DECLS
  65
  66 typedef struct _GtkTextIter GtkTextIter;
  67 typedef struct _GtkTextTagTable GtkTextTagTable;
  68
  69 typedef struct _GtkTextAttributes GtkTextAttributes;
  70
  71 #define GTK_TYPE_TEXT_TAG            (gtk_text_tag_get_type ())
  72 #define GTK_TEXT_TAG(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_TAG, GtkTextTag))
  73 #define GTK_TEXT_TAG_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_TAG, GtkTextTagClass))
  74 #define GTK_IS_TEXT_TAG(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_TAG))
  75 #define GTK_IS_TEXT_TAG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_TAG))
  76 #define GTK_TEXT_TAG_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_TAG, GtkTextTagClass))
  77
  78 #define GTK_TYPE_TEXT_ATTRIBUTES     (gtk_text_attributes_get_type ())
  79
  80 typedef struct _GtkTextTag GtkTextTag;
  81 typedef struct _GtkTextTagClass GtkTextTagClass;
  82
  83 struct _GtkTextTag
  84 {
  85   GObject parent_instance;
  86
  87   GtkTextTagTable *table;
  88
  89   char *name;                   /* Name of this tag.  This field is actually
  90                                  * a pointer to the key from the entry in
  91                                  * tkxt->tagTable, so it needn't be freed
  92                                  * explicitly. */
  93   int priority;         /* Priority of this tag within widget.  0
  94                          * means lowest priority.  Exactly one tag
  95                          * has each integer value between 0 and
  96                          * numTags-1. */
  97   /*
  98    * Information for displaying text with this tag.  The information
  99    * belows acts as an override on information specified by lower-priority
 100    * tags.  If no value is specified, then the next-lower-priority tag
 101    * on the text determins the value.  The text widget itself provides
 102    * defaults if no tag specifies an override.
 103    */
 104
 105   GtkTextAttributes *values;
 106
 107   /* Flags for whether a given value is set; if a value is unset, then
 108    * this tag does not affect it.
 109    */
 110   guint bg_color_set : 1;
 111   guint bg_stipple_set : 1;
 112   guint fg_color_set : 1;
 113   guint scale_set : 1;
 114   guint fg_stipple_set : 1;
 115   guint justification_set : 1;
 116   guint left_margin_set : 1;
 117   guint indent_set : 1;
 118   guint rise_set : 1;
 119   guint strikethrough_set : 1;
 120   guint right_margin_set : 1;
 121   guint pixels_above_lines_set : 1;
 122   guint pixels_below_lines_set : 1;
 123   guint pixels_inside_wrap_set : 1;
 124   guint tabs_set : 1;
 125   guint underline_set : 1;
 126   guint wrap_mode_set : 1;
 127   guint bg_full_height_set : 1;
 128   guint invisible_set : 1;
 129   guint editable_set : 1;
 130   guint language_set : 1;
 131   guint pg_bg_color_set : 1;
 132
 133   /* Whether these margins accumulate or override */
 134   guint accumulative_margin : 1;
 135
 136   guint pad1 : 1;
 137 };
 138
 139 struct _GtkTextTagClass
 140 {
 141   GObjectClass parent_class;
 142
 143   gboolean (* event) (GtkTextTag        *tag,
 144                       GObject           *event_object, /* widget, canvas item, whatever */
 145                       GdkEvent          *event,        /* the event itself */
 146                       const GtkTextIter *iter);        /* location of event in buffer */
 147
 148   /* Padding for future expansion */
 149   void (*_gtk_reserved1) (void);
 150   void (*_gtk_reserved2) (void);
 151   void (*_gtk_reserved3) (void);
 152   void (*_gtk_reserved4) (void);
 153 };
 154
 155 GType        gtk_text_tag_get_type     (void) G_GNUC_CONST;
 156 GtkTextTag  *gtk_text_tag_new          (const gchar       *name);
 157 gint         gtk_text_tag_get_priority (GtkTextTag        *tag);
 158 void         gtk_text_tag_set_priority (GtkTextTag        *tag,
 159                                         gint               priority);
 160 gboolean     gtk_text_tag_event        (GtkTextTag        *tag,
 161                                         GObject           *event_object,
 162                                         GdkEvent          *event,
 163                                         const GtkTextIter *iter);
 164
 165 /*
 166  * Style object created by folding a set of tags together
 167  */
 168
 169 typedef struct _GtkTextAppearance GtkTextAppearance;
 170
 171 struct _GtkTextAppearance
 172 {
 173   /*< public >*/
 174   GdkColor bg_color;
 175   GdkColor fg_color;
 176   GdkBitmap *bg_stipple;
 177   GdkBitmap *fg_stipple;
 178
 179   /* super/subscript rise, can be negative */
 180   gint rise;
 181
 182   /*< private >*/
 183   /* I'm not sure this can really be used without breaking some things
 184    * an app might do :-/
 185    */
 186   gpointer padding1;
 187
 188   /*< public >*/
 189   guint underline : 4;          /* PangoUnderline */
 190   guint strikethrough : 1;
 191
 192   /* Whether to use background-related values; this is irrelevant for
 193    * the values struct when in a tag, but is used for the composite
 194    * values struct; it's true if any of the tags being composited
 195    * had background stuff set.
 196    */
 197   guint draw_bg : 1;
 198
 199   /* These are only used when we are actually laying out and rendering
 200    * a paragraph; not when a GtkTextAppearance is part of a
 201    * GtkTextAttributes.
 202    */
 203   guint inside_selection : 1;
 204   guint is_text : 1;
 205
 206   /*< private >*/
 207   guint pad1 : 1;
 208   guint pad2 : 1;
 209   guint pad3 : 1;
 210   guint pad4 : 1;
 211 };
 212
 213 struct _GtkTextAttributes
 214 {
 215   /*< private >*/
 216   guint refcount;
 217
 218   /*< public >*/
 219   GtkTextAppearance appearance;
 220
 221   GtkJustification justification;
 222   GtkTextDirection direction;
 223
 224   /* Individual chunks of this can be set/unset as a group */
 225   PangoFontDescription *font;
 226
 227   gdouble font_scale;
 228
 229   gint left_margin;
 230
 231   gint indent;
 232
 233   gint right_margin;
 234
 235   gint pixels_above_lines;
 236
 237   gint pixels_below_lines;
 238
 239   gint pixels_inside_wrap;
 240
 241   PangoTabArray *tabs;
 242
 243   GtkWrapMode wrap_mode;        /* How to handle wrap-around for this tag.
 244                                  * Must be GTK_WRAPMODE_CHAR,
 245                                  * GTK_WRAPMODE_NONE, GTK_WRAPMODE_WORD
 246                                  */
 247
 248   PangoLanguage *language;
 249
 250   /*< private >*/
 251   GdkColor *pg_bg_color;
 252
 253   /*< public >*/
 254   /* hide the text  */
 255   guint invisible : 1;
 256
 257   /* Background is fit to full line height rather than
 258    * baseline +/- ascent/descent (font height)
 259    */
 260   guint bg_full_height : 1;
 261
 262   /* can edit this text */
 263   guint editable : 1;
 264
 265   /* colors are allocated etc. */
 266   guint realized : 1;
 267
 268   /*< private >*/
 269   guint pad1 : 1;
 270   guint pad2 : 1;
 271   guint pad3 : 1;
 272   guint pad4 : 1;
 273 };
 274
 275 GtkTextAttributes* gtk_text_attributes_new         (void);
 276 GtkTextAttributes* gtk_text_attributes_copy        (GtkTextAttributes *src);
 277 void               gtk_text_attributes_copy_values (GtkTextAttributes *src,
 278                                                     GtkTextAttributes *dest);
 279 void               gtk_text_attributes_unref       (GtkTextAttributes *values);
 280 GtkTextAttributes *gtk_text_attributes_ref         (GtkTextAttributes *values);
 281
 282 GType              gtk_text_attributes_get_type    (void) G_GNUC_CONST;
 283
 284
 285 G_END_DECLS
 286
 287 #endif
 288