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