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