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