gtk2/gtk/gtklabel.h

/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

#ifndef __GTK_LABEL_H__
#define __GTK_LABEL_H__


#include <gdk/gdk.h>
#include <gtk/gtkmisc.h>
#include <gtk/gtkwindow.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


#define GTK_TYPE_LABEL		  (gtk_label_get_type ())
#define GTK_LABEL(obj)		  (GTK_CHECK_CAST ((obj), GTK_TYPE_LABEL, GtkLabel))
#define GTK_LABEL_CLASS(klass)	  (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_LABEL, GtkLabelClass))
#define GTK_IS_LABEL(obj)	  (GTK_CHECK_TYPE ((obj), GTK_TYPE_LABEL))
#define GTK_IS_LABEL_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LABEL))
#define GTK_LABEL_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_LABEL, GtkLabelClass))
       

typedef struct _GtkLabel       GtkLabel;
typedef struct _GtkLabelClass  GtkLabelClass;

typedef struct _GtkLabelSelectionInfo GtkLabelSelectionInfo;

struct _GtkLabel
{
  GtkMisc misc;

  /*< private >*/
  gchar  *label;
  guint   jtype : 2;
  guint   wrap : 1;
  guint   use_underline : 1;
  guint   use_markup : 1;

  guint   mnemonic_keyval;
  
  gchar  *text; 
  PangoAttrList *attrs;
  
  PangoLayout *layout;

  GtkWidget *mnemonic_widget;
  GtkWindow *mnemonic_window;
  
  GtkLabelSelectionInfo *select_info;
};

struct _GtkLabelClass
{
  GtkMiscClass parent_class;
};

GtkType    gtk_label_get_type          (void) G_GNUC_CONST;
GtkWidget *gtk_label_new               (const char       *str);
GtkWidget *gtk_label_new_with_mnemonic (const char       *str);

void                  gtk_label_set_text (GtkLabel   *label,
					  const char *str);
G_CONST_RETURN gchar *gtk_label_get_text (GtkLabel   *label);

void       gtk_label_set_attributes (GtkLabel         *label,
                                     PangoAttrList    *attrs);

void  gtk_label_set_markup            (GtkLabel    *label,
                                       const gchar *str);
void  gtk_label_set_markup_with_mnemonic (GtkLabel    *label,
					  const gchar *str);

guint gtk_label_get_mnemonic_keyval (GtkLabel    *label);
void       gtk_label_set_justify    (GtkLabel         *label,
				     GtkJustification  jtype);
void       gtk_label_set_pattern    (GtkLabel         *label,
				     const gchar      *pattern);
void       gtk_label_set_line_wrap  (GtkLabel         *label,
				     gboolean          wrap);

void  gtk_label_set_text_with_mnemonic (GtkLabel    *label,
					const gchar *string);
void  gtk_label_set_mnemonic_widget    (GtkLabel    *label,
					GtkWidget   *widget);

void     gtk_label_set_selectable (GtkLabel *label,
                                   gboolean  setting);
gboolean gtk_label_get_selectable (GtkLabel *label);

void     gtk_label_select_region  (GtkLabel *label,
                                   gint      start_offset,
                                   gint      end_offset);

void     gtk_label_get_layout_offsets (GtkLabel *label,
                                       gint     *x,
                                       gint     *y);

#ifndef	GTK_DISABLE_COMPAT_H
#  define gtk_label_set				gtk_label_set_text
#endif	/* GTK_DISABLE_COMPAT_H */

#ifndef GTK_DISABLE_DEPRECATED
/* Deprecated */
void       gtk_label_get           (GtkLabel          *label,
                                    char             **str);

/* Convenience function to set the name and pattern by parsing
 * a string with embedded underscores, and return the appropriate
 * key symbol for the accelerator.
 */
guint gtk_label_parse_uline            (GtkLabel    *label,
					const gchar *string);

#endif /* GTK_DISABLE_DEPRECATED */

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_LABEL_H__ */