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
  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)            (GTK_CHECK_CAST ((obj), GTK_TYPE_LABEL, GtkLabel))
  42 #define GTK_LABEL_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_LABEL, GtkLabelClass))
  43 #define GTK_IS_LABEL(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_LABEL))
  44 #define GTK_IS_LABEL_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LABEL))
  45 #define GTK_LABEL_GET_CLASS(obj)  (GTK_CHECK_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
  64   guint   mnemonic_keyval;
  65
  66   gchar  *text;
  67   PangoAttrList *attrs;
  68
  69   PangoLayout *layout;
  70
  71   GtkWidget *mnemonic_widget;
  72   GtkWindow *mnemonic_window;
  73
  74   GtkLabelSelectionInfo *select_info;
  75 };
  76
  77 struct _GtkLabelClass
  78 {
  79   GtkMiscClass parent_class;
  80 };
  81
  82 GtkType    gtk_label_get_type          (void) G_GNUC_CONST;
  83 GtkWidget *gtk_label_new               (const char       *str);
  84 GtkWidget *gtk_label_new_with_mnemonic (const char       *str);
  85
  86 void                  gtk_label_set_text (GtkLabel   *label,
  87                                           const char *str);
  88 G_CONST_RETURN gchar *gtk_label_get_text (GtkLabel   *label);
  89
  90 void       gtk_label_set_attributes (GtkLabel         *label,
  91                                      PangoAttrList    *attrs);
  92
  93 void  gtk_label_set_markup            (GtkLabel    *label,
  94                                        const gchar *str);
  95 void  gtk_label_set_markup_with_mnemonic (GtkLabel    *label,
  96                                           const gchar *str);
  97
  98 guint gtk_label_get_mnemonic_keyval (GtkLabel    *label);
  99 void       gtk_label_set_justify    (GtkLabel         *label,
 100                                      GtkJustification  jtype);
 101 void       gtk_label_set_pattern    (GtkLabel         *label,
 102                                      const gchar      *pattern);
 103 void       gtk_label_set_line_wrap  (GtkLabel         *label,
 104                                      gboolean          wrap);
 105 /* Convenience function to set the name and pattern by parsing
 106  * a string with embedded underscores, and return the appropriate
 107  * key symbol for the accelerator.
 108  */
 109 guint gtk_label_parse_uline            (GtkLabel    *label,
 110                                         const gchar *string);
 111 void  gtk_label_set_text_with_mnemonic (GtkLabel    *label,
 112                                         const gchar *string);
 113 void  gtk_label_set_mnemonic_widget    (GtkLabel    *label,
 114                                         GtkWidget   *widget);
 115
 116 void     gtk_label_set_selectable (GtkLabel *label,
 117                                    gboolean  setting);
 118 gboolean gtk_label_get_selectable (GtkLabel *label);
 119
 120 void     gtk_label_select_region  (GtkLabel *label,
 121                                    gint      start_offset,
 122                                    gint      end_offset);
 123
 124 void     gtk_label_get_layout_offsets (GtkLabel *label,
 125                                        gint     *x,
 126                                        gint     *y);
 127
 128 #ifndef GTK_DISABLE_COMPAT_H
 129 #  define gtk_label_set                         gtk_label_set_text
 130 #endif  /* GTK_DISABLE_COMPAT_H */
 131
 132 #ifndef GTK_DISABLE_DEPRECATED
 133 /* Deprecated */
 134 void       gtk_label_get           (GtkLabel          *label,
 135                                     char             **str);
 136 #endif /* GTK_DISABLE_DEPRECATED */
 137
 138 #ifdef __cplusplus
 139 }
 140 #endif /* __cplusplus */
 141
 142
 143 #endif /* __GTK_LABEL_H__ */