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 #include <gtk/gtkwindow.h>
  33 #include <gtk/gtkmenu.h>
  34
  35 G_BEGIN_DECLS
  36
  37 #define GTK_TYPE_LABEL            (gtk_label_get_type ())
  38 #define GTK_LABEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LABEL, GtkLabel))
  39 #define GTK_LABEL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LABEL, GtkLabelClass))
  40 #define GTK_IS_LABEL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LABEL))
  41 #define GTK_IS_LABEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LABEL))
  42 #define GTK_LABEL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LABEL, GtkLabelClass))
  43
  44
  45 typedef struct _GtkLabel       GtkLabel;
  46 typedef struct _GtkLabelClass  GtkLabelClass;
  47
  48 typedef struct _GtkLabelSelectionInfo GtkLabelSelectionInfo;
  49
  50 struct _GtkLabel
  51 {
  52   GtkMisc misc;
  53
  54   /*< private >*/
  55   gchar  *label;
  56   guint   jtype            : 2;
  57   guint   wrap             : 1;
  58   guint   use_underline    : 1;
  59   guint   use_markup       : 1;
  60   guint   ellipsize        : 3;
  61   guint   single_line_mode : 1;
  62   guint   have_transform   : 1;
  63   guint   in_click         : 1;
  64   guint   wrap_mode        : 3;
  65   guint   pattern_set      : 1;
  66
  67   guint   mnemonic_keyval;
  68
  69   gchar  *text;
  70   PangoAttrList *attrs;
  71   PangoAttrList *effective_attrs;
  72
  73   PangoLayout *layout;
  74
  75   GtkWidget *mnemonic_widget;
  76   GtkWindow *mnemonic_window;
  77
  78   GtkLabelSelectionInfo *select_info;
  79 };
  80
  81 struct _GtkLabelClass
  82 {
  83   GtkMiscClass parent_class;
  84
  85   void (* move_cursor)     (GtkLabel       *label,
  86                             GtkMovementStep step,
  87                             gint            count,
  88                             gboolean        extend_selection);
  89   void (* copy_clipboard)  (GtkLabel       *label);
  90
  91   /* Hook to customize right-click popup for selectable labels */
  92   void (* populate_popup)   (GtkLabel       *label,
  93                              GtkMenu        *menu);
  94
  95   /* Padding for future expansion */
  96   void (*_gtk_reserved1) (void);
  97   void (*_gtk_reserved2) (void);
  98   void (*_gtk_reserved3) (void);
  99   void (*_gtk_reserved4) (void);
 100 };
 101
 102 GType                 gtk_label_get_type          (void) G_GNUC_CONST;
 103 GtkWidget*            gtk_label_new               (const gchar   *str);
 104 GtkWidget*            gtk_label_new_with_mnemonic (const gchar   *str);
 105 void                  gtk_label_set_text          (GtkLabel      *label,
 106                                                    const gchar   *str);
 107 G_CONST_RETURN gchar* gtk_label_get_text          (GtkLabel      *label);
 108 void                  gtk_label_set_attributes    (GtkLabel      *label,
 109                                                    PangoAttrList *attrs);
 110 PangoAttrList        *gtk_label_get_attributes    (GtkLabel      *label);
 111 void                  gtk_label_set_label         (GtkLabel      *label,
 112                                                    const gchar   *str);
 113 G_CONST_RETURN gchar *gtk_label_get_label         (GtkLabel      *label);
 114 void                  gtk_label_set_markup        (GtkLabel      *label,
 115                                                    const gchar   *str);
 116 void                  gtk_label_set_use_markup    (GtkLabel      *label,
 117                                                    gboolean       setting);
 118 gboolean              gtk_label_get_use_markup    (GtkLabel      *label);
 119 void                  gtk_label_set_use_underline (GtkLabel      *label,
 120                                                    gboolean       setting);
 121 gboolean              gtk_label_get_use_underline (GtkLabel      *label);
 122
 123 void     gtk_label_set_markup_with_mnemonic       (GtkLabel         *label,
 124                                                    const gchar      *str);
 125 guint    gtk_label_get_mnemonic_keyval            (GtkLabel         *label);
 126 void     gtk_label_set_mnemonic_widget            (GtkLabel         *label,
 127                                                    GtkWidget        *widget);
 128 GtkWidget *gtk_label_get_mnemonic_widget          (GtkLabel         *label);
 129 void     gtk_label_set_text_with_mnemonic         (GtkLabel         *label,
 130                                                    const gchar      *str);
 131 void     gtk_label_set_justify                    (GtkLabel         *label,
 132                                                    GtkJustification  jtype);
 133 GtkJustification gtk_label_get_justify            (GtkLabel         *label);
 134 void     gtk_label_set_ellipsize                  (GtkLabel         *label,
 135                                                    PangoEllipsizeMode mode);
 136 PangoEllipsizeMode gtk_label_get_ellipsize        (GtkLabel         *label);
 137 void     gtk_label_set_width_chars                (GtkLabel         *label,
 138                                                    gint              n_chars);
 139 gint     gtk_label_get_width_chars                (GtkLabel         *label);
 140 void     gtk_label_set_max_width_chars            (GtkLabel         *label,
 141                                                    gint              n_chars);
 142 gint     gtk_label_get_max_width_chars            (GtkLabel         *label);
 143 void     gtk_label_set_pattern                    (GtkLabel         *label,
 144                                                    const gchar      *pattern);
 145 void     gtk_label_set_line_wrap                  (GtkLabel         *label,
 146                                                    gboolean          wrap);
 147 gboolean gtk_label_get_line_wrap                  (GtkLabel         *label);
 148 void     gtk_label_set_line_wrap_mode             (GtkLabel         *label,
 149                                                    PangoWrapMode     wrap_mode);
 150 PangoWrapMode gtk_label_get_line_wrap_mode        (GtkLabel         *label);
 151 void     gtk_label_set_selectable                 (GtkLabel         *label,
 152                                                    gboolean          setting);
 153 gboolean gtk_label_get_selectable                 (GtkLabel         *label);
 154 void     gtk_label_set_angle                      (GtkLabel         *label,
 155                                                    gdouble           angle);
 156 gdouble  gtk_label_get_angle                      (GtkLabel         *label);
 157 void     gtk_label_select_region                  (GtkLabel         *label,
 158                                                    gint              start_offset,
 159                                                    gint              end_offset);
 160 gboolean gtk_label_get_selection_bounds           (GtkLabel         *label,
 161                                                    gint             *start,
 162                                                    gint             *end);
 163
 164 PangoLayout *gtk_label_get_layout         (GtkLabel *label);
 165 void         gtk_label_get_layout_offsets (GtkLabel *label,
 166                                            gint     *x,
 167                                            gint     *y);
 168
 169 void         gtk_label_set_single_line_mode  (GtkLabel *label,
 170                                               gboolean single_line_mode);
 171 gboolean     gtk_label_get_single_line_mode  (GtkLabel *label);
 172
 173 #ifndef GTK_DISABLE_DEPRECATED
 174
 175 #define  gtk_label_set           gtk_label_set_text
 176 void       gtk_label_get           (GtkLabel          *label,
 177                                     gchar            **str);
 178
 179 /* Convenience function to set the name and pattern by parsing
 180  * a string with embedded underscores, and return the appropriate
 181  * key symbol for the accelerator.
 182  */
 183 guint gtk_label_parse_uline            (GtkLabel    *label,
 184                                         const gchar *string);
 185
 186 #endif /* GTK_DISABLE_DEPRECATED */
 187
 188 G_END_DECLS
 189
 190 #endif /* __GTK_LABEL_H__ */