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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free
  16  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 /*
  20  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  21  * file for a list of people on the GTK+ Team.  See the ChangeLog
  22  * files for a list of changes.  These files are distributed with
  23  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  24  */
  25
  26 #ifndef __GTK_LABEL_H__
  27 #define __GTK_LABEL_H__
  28
  29
  30 #include <gdk/gdk.h>
  31 #include <gtk/gtkmisc.h>
  32
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif /* __cplusplus */
  37
  38
  39 #define GTK_TYPE_LABEL            (gtk_label_get_type ())
  40 #define GTK_LABEL(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_LABEL, GtkLabel))
  41 #define GTK_LABEL_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_LABEL, GtkLabelClass))
  42 #define GTK_IS_LABEL(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_LABEL))
  43 #define GTK_IS_LABEL_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LABEL))
  44 #define GTK_LABEL_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_LABEL, GtkLabelClass))
  45
  46
  47 typedef struct _GtkLabel       GtkLabel;
  48 typedef struct _GtkLabelClass  GtkLabelClass;
  49
  50 typedef struct _GtkLabelSelectionInfo GtkLabelSelectionInfo;
  51
  52 struct _GtkLabel
  53 {
  54   GtkMisc misc;
  55
  56   /*< private >*/
  57   gchar  *label;
  58   guint   jtype : 2;
  59   guint   wrap : 1;
  60   guint   use_underline : 1;
  61   guint   use_markup : 1;
  62
  63   guint   accel_keyval;
  64
  65   gchar  *text;
  66   PangoAttrList *attrs;
  67
  68   PangoLayout *layout;
  69
  70   GtkLabelSelectionInfo *select_info;
  71 };
  72
  73 struct _GtkLabelClass
  74 {
  75   GtkMiscClass parent_class;
  76 };
  77
  78 GtkType    gtk_label_get_type       (void) G_GNUC_CONST;
  79 GtkWidget *gtk_label_new            (const char       *str);
  80
  81 void                  gtk_label_set_text (GtkLabel   *label,
  82                                           const char *str);
  83 G_CONST_RETURN gchar *gtk_label_get_text (GtkLabel   *label);
  84
  85 void       gtk_label_set_attributes (GtkLabel         *label,
  86                                      PangoAttrList    *attrs);
  87
  88 void  gtk_label_set_markup            (GtkLabel    *label,
  89                                        const gchar *str);
  90 guint gtk_label_set_markup_with_accel (GtkLabel    *label,
  91                                        const gchar *str);
  92
  93 guint gtk_label_get_accel_keyval   (GtkLabel    *label);
  94 void       gtk_label_set_justify   (GtkLabel         *label,
  95                                     GtkJustification  jtype);
  96 void       gtk_label_set_pattern   (GtkLabel         *label,
  97                                     const gchar      *pattern);
  98 void       gtk_label_set_line_wrap (GtkLabel         *label,
  99                                     gboolean          wrap);
 100 /* Convenience function to set the name and pattern by parsing
 101  * a string with embedded underscores, and return the appropriate
 102  * key symbol for the accelerator.
 103  */
 104 guint       gtk_label_parse_uline   (GtkLabel         *label,
 105                                      const gchar      *string);
 106
 107 void     gtk_label_set_selectable (GtkLabel *label,
 108                                    gboolean  setting);
 109 gboolean gtk_label_get_selectable (GtkLabel *label);
 110
 111 void     gtk_label_select_region  (GtkLabel *label,
 112                                    gint      start_offset,
 113                                    gint      end_offset);
 114
 115 #ifndef GTK_DISABLE_COMPAT_H
 116 #  define gtk_label_set                         gtk_label_set_text
 117 #endif  /* GTK_DISABLE_COMPAT_H */
 118
 119 #ifndef GTK_DISABLE_DEPRECATED
 120 /* Deprecated */
 121 void       gtk_label_get           (GtkLabel          *label,
 122                                     char             **str);
 123 #endif /* GTK_DISABLE_DEPRECATED */
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif /* __cplusplus */
 128
 129
 130 #endif /* __GTK_LABEL_H__ */