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_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 <gtk/gtkmisc.h>
  35 #include <gtk/gtkwindow.h>
  36 #include <gtk/gtkmenu.h>
  37
  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 _GtkLabelPriv   GtkLabelPriv;
  51 typedef struct _GtkLabelClass  GtkLabelClass;
  52
  53 typedef struct _GtkLabelSelectionInfo GtkLabelSelectionInfo;
  54
  55 struct _GtkLabel
  56 {
  57   GtkMisc misc;
  58
  59   /*< private >*/
  60   GtkLabelPriv *priv;
  61 };
  62
  63 struct _GtkLabelClass
  64 {
  65   GtkMiscClass parent_class;
  66
  67   void (* move_cursor)     (GtkLabel       *label,
  68                             GtkMovementStep step,
  69                             gint            count,
  70                             gboolean        extend_selection);
  71   void (* copy_clipboard)  (GtkLabel       *label);
  72
  73   /* Hook to customize right-click popup for selectable labels */
  74   void (* populate_popup)   (GtkLabel       *label,
  75                              GtkMenu        *menu);
  76
  77   gboolean (*activate_link) (GtkLabel       *label,
  78                              const gchar    *uri);
  79
  80   /* Padding for future expansion */
  81   void (*_gtk_reserved1) (void);
  82   void (*_gtk_reserved2) (void);
  83   void (*_gtk_reserved3) (void);
  84 };
  85
  86 GType                 gtk_label_get_type          (void) G_GNUC_CONST;
  87 GtkWidget*            gtk_label_new               (const gchar   *str);
  88 GtkWidget*            gtk_label_new_with_mnemonic (const gchar   *str);
  89 void                  gtk_label_set_text          (GtkLabel      *label,
  90                                                    const gchar   *str);
  91 G_CONST_RETURN gchar* gtk_label_get_text          (GtkLabel      *label);
  92 void                  gtk_label_set_attributes    (GtkLabel      *label,
  93                                                    PangoAttrList *attrs);
  94 PangoAttrList        *gtk_label_get_attributes    (GtkLabel      *label);
  95 void                  gtk_label_set_label         (GtkLabel      *label,
  96                                                    const gchar   *str);
  97 G_CONST_RETURN gchar *gtk_label_get_label         (GtkLabel      *label);
  98 void                  gtk_label_set_markup        (GtkLabel      *label,
  99                                                    const gchar   *str);
 100 void                  gtk_label_set_use_markup    (GtkLabel      *label,
 101                                                    gboolean       setting);
 102 gboolean              gtk_label_get_use_markup    (GtkLabel      *label);
 103 void                  gtk_label_set_use_underline (GtkLabel      *label,
 104                                                    gboolean       setting);
 105 gboolean              gtk_label_get_use_underline (GtkLabel      *label);
 106
 107 void     gtk_label_set_markup_with_mnemonic       (GtkLabel         *label,
 108                                                    const gchar      *str);
 109 guint    gtk_label_get_mnemonic_keyval            (GtkLabel         *label);
 110 void     gtk_label_set_mnemonic_widget            (GtkLabel         *label,
 111                                                    GtkWidget        *widget);
 112 GtkWidget *gtk_label_get_mnemonic_widget          (GtkLabel         *label);
 113 void     gtk_label_set_text_with_mnemonic         (GtkLabel         *label,
 114                                                    const gchar      *str);
 115 void     gtk_label_set_justify                    (GtkLabel         *label,
 116                                                    GtkJustification  jtype);
 117 GtkJustification gtk_label_get_justify            (GtkLabel         *label);
 118 void     gtk_label_set_ellipsize                  (GtkLabel         *label,
 119                                                    PangoEllipsizeMode mode);
 120 PangoEllipsizeMode gtk_label_get_ellipsize        (GtkLabel         *label);
 121 void     gtk_label_set_width_chars                (GtkLabel         *label,
 122                                                    gint              n_chars);
 123 gint     gtk_label_get_width_chars                (GtkLabel         *label);
 124 void     gtk_label_set_max_width_chars            (GtkLabel         *label,
 125                                                    gint              n_chars);
 126 gint     gtk_label_get_max_width_chars            (GtkLabel         *label);
 127 void     gtk_label_set_pattern                    (GtkLabel         *label,
 128                                                    const gchar      *pattern);
 129 void     gtk_label_set_line_wrap                  (GtkLabel         *label,
 130                                                    gboolean          wrap);
 131 gboolean gtk_label_get_line_wrap                  (GtkLabel         *label);
 132 void     gtk_label_set_line_wrap_mode             (GtkLabel         *label,
 133                                                    PangoWrapMode     wrap_mode);
 134 PangoWrapMode gtk_label_get_line_wrap_mode        (GtkLabel         *label);
 135 void     gtk_label_set_selectable                 (GtkLabel         *label,
 136                                                    gboolean          setting);
 137 gboolean gtk_label_get_selectable                 (GtkLabel         *label);
 138 void     gtk_label_set_angle                      (GtkLabel         *label,
 139                                                    gdouble           angle);
 140 gdouble  gtk_label_get_angle                      (GtkLabel         *label);
 141 void     gtk_label_select_region                  (GtkLabel         *label,
 142                                                    gint              start_offset,
 143                                                    gint              end_offset);
 144 gboolean gtk_label_get_selection_bounds           (GtkLabel         *label,
 145                                                    gint             *start,
 146                                                    gint             *end);
 147
 148 PangoLayout *gtk_label_get_layout         (GtkLabel *label);
 149 void         gtk_label_get_layout_offsets (GtkLabel *label,
 150                                            gint     *x,
 151                                            gint     *y);
 152
 153 void         gtk_label_set_single_line_mode  (GtkLabel *label,
 154                                               gboolean single_line_mode);
 155 gboolean     gtk_label_get_single_line_mode  (GtkLabel *label);
 156
 157 G_CONST_RETURN gchar *gtk_label_get_current_uri (GtkLabel *label);
 158 void         gtk_label_set_track_visited_links  (GtkLabel *label,
 159                                                  gboolean  track_links);
 160 gboolean     gtk_label_get_track_visited_links  (GtkLabel *label);
 161
 162
 163 /* private */
 164
 165 void _gtk_label_mnemonics_visible_apply_recursively (GtkWidget *widget,
 166                                                      gboolean   mnemonics_visible);
 167
 168 G_END_DECLS
 169
 170 #endif /* __GTK_LABEL_H__ */