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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __GTK_LABEL_H__
  26 #define __GTK_LABEL_H__
  27
  28
  29 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  30 #error "Only <gtk/gtk.h> can be included directly."
  31 #endif
  32
  33 #include <gtk/gtkmisc.h>
  34 #include <gtk/gtkwindow.h>
  35 #include <gtk/gtkmenu.h>
  36
  37
  38 G_BEGIN_DECLS
  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 _GtkLabelPrivate       GtkLabelPrivate;
  50 typedef struct _GtkLabelClass         GtkLabelClass;
  51
  52 typedef struct _GtkLabelSelectionInfo GtkLabelSelectionInfo;
  53
  54 struct _GtkLabel
  55 {
  56   GtkMisc misc;
  57
  58   /*< private >*/
  59   GtkLabelPrivate *priv;
  60 };
  61
  62 struct _GtkLabelClass
  63 {
  64   GtkMiscClass parent_class;
  65
  66   void (* move_cursor)     (GtkLabel       *label,
  67                             GtkMovementStep step,
  68                             gint            count,
  69                             gboolean        extend_selection);
  70   void (* copy_clipboard)  (GtkLabel       *label);
  71
  72   /* Hook to customize right-click popup for selectable labels */
  73   void (* populate_popup)   (GtkLabel       *label,
  74                              GtkMenu        *menu);
  75
  76   gboolean (*activate_link) (GtkLabel       *label,
  77                              const gchar    *uri);
  78
  79   /* Padding for future expansion */
  80   void (*_gtk_reserved1) (void);
  81   void (*_gtk_reserved2) (void);
  82   void (*_gtk_reserved3) (void);
  83   void (*_gtk_reserved4) (void);
  84   void (*_gtk_reserved5) (void);
  85   void (*_gtk_reserved6) (void);
  86   void (*_gtk_reserved7) (void);
  87   void (*_gtk_reserved8) (void);
  88 };
  89
  90 GType                 gtk_label_get_type          (void) G_GNUC_CONST;
  91 GtkWidget*            gtk_label_new               (const gchar   *str);
  92 GtkWidget*            gtk_label_new_with_mnemonic (const gchar   *str);
  93 void                  gtk_label_set_text          (GtkLabel      *label,
  94                                                    const gchar   *str);
  95 const gchar*          gtk_label_get_text          (GtkLabel      *label);
  96 void                  gtk_label_set_attributes    (GtkLabel      *label,
  97                                                    PangoAttrList *attrs);
  98 PangoAttrList        *gtk_label_get_attributes    (GtkLabel      *label);
  99 void                  gtk_label_set_label         (GtkLabel      *label,
 100                                                    const gchar   *str);
 101 const gchar *         gtk_label_get_label         (GtkLabel      *label);
 102 void                  gtk_label_set_markup        (GtkLabel      *label,
 103                                                    const gchar   *str);
 104 void                  gtk_label_set_use_markup    (GtkLabel      *label,
 105                                                    gboolean       setting);
 106 gboolean              gtk_label_get_use_markup    (GtkLabel      *label);
 107 void                  gtk_label_set_use_underline (GtkLabel      *label,
 108                                                    gboolean       setting);
 109 gboolean              gtk_label_get_use_underline (GtkLabel      *label);
 110
 111 void     gtk_label_set_markup_with_mnemonic       (GtkLabel         *label,
 112                                                    const gchar      *str);
 113 guint    gtk_label_get_mnemonic_keyval            (GtkLabel         *label);
 114 void     gtk_label_set_mnemonic_widget            (GtkLabel         *label,
 115                                                    GtkWidget        *widget);
 116 GtkWidget *gtk_label_get_mnemonic_widget          (GtkLabel         *label);
 117 void     gtk_label_set_text_with_mnemonic         (GtkLabel         *label,
 118                                                    const gchar      *str);
 119 void     gtk_label_set_justify                    (GtkLabel         *label,
 120                                                    GtkJustification  jtype);
 121 GtkJustification gtk_label_get_justify            (GtkLabel         *label);
 122 void     gtk_label_set_ellipsize                  (GtkLabel         *label,
 123                                                    PangoEllipsizeMode mode);
 124 PangoEllipsizeMode gtk_label_get_ellipsize        (GtkLabel         *label);
 125 void     gtk_label_set_width_chars                (GtkLabel         *label,
 126                                                    gint              n_chars);
 127 gint     gtk_label_get_width_chars                (GtkLabel         *label);
 128 void     gtk_label_set_max_width_chars            (GtkLabel         *label,
 129                                                    gint              n_chars);
 130 gint     gtk_label_get_max_width_chars            (GtkLabel         *label);
 131 void     gtk_label_set_pattern                    (GtkLabel         *label,
 132                                                    const gchar      *pattern);
 133 void     gtk_label_set_line_wrap                  (GtkLabel         *label,
 134                                                    gboolean          wrap);
 135 gboolean gtk_label_get_line_wrap                  (GtkLabel         *label);
 136 void     gtk_label_set_line_wrap_mode             (GtkLabel         *label,
 137                                                    PangoWrapMode     wrap_mode);
 138 PangoWrapMode gtk_label_get_line_wrap_mode        (GtkLabel         *label);
 139 void     gtk_label_set_selectable                 (GtkLabel         *label,
 140                                                    gboolean          setting);
 141 gboolean gtk_label_get_selectable                 (GtkLabel         *label);
 142 void     gtk_label_set_angle                      (GtkLabel         *label,
 143                                                    gdouble           angle);
 144 gdouble  gtk_label_get_angle                      (GtkLabel         *label);
 145 void     gtk_label_select_region                  (GtkLabel         *label,
 146                                                    gint              start_offset,
 147                                                    gint              end_offset);
 148 gboolean gtk_label_get_selection_bounds           (GtkLabel         *label,
 149                                                    gint             *start,
 150                                                    gint             *end);
 151
 152 PangoLayout *gtk_label_get_layout         (GtkLabel *label);
 153 void         gtk_label_get_layout_offsets (GtkLabel *label,
 154                                            gint     *x,
 155                                            gint     *y);
 156
 157 void         gtk_label_set_single_line_mode  (GtkLabel *label,
 158                                               gboolean single_line_mode);
 159 gboolean     gtk_label_get_single_line_mode  (GtkLabel *label);
 160
 161 const gchar *gtk_label_get_current_uri (GtkLabel *label);
 162 void         gtk_label_set_track_visited_links  (GtkLabel *label,
 163                                                  gboolean  track_links);
 164 gboolean     gtk_label_get_track_visited_links  (GtkLabel *label);
 165
 166
 167 /* private */
 168
 169 void _gtk_label_mnemonics_visible_apply_recursively (GtkWidget *widget,
 170                                                      gboolean   mnemonics_visible);
 171 gint _gtk_label_get_cursor_position (GtkLabel *label);
 172 gint _gtk_label_get_selection_bound (GtkLabel *label);
 173
 174 G_END_DECLS
 175
 176 #endif /* __GTK_LABEL_H__ */