Pileus Git - ~andy/gtk/blob - gtk/gtkexpander.h

   1 /* GTK - The GIMP Toolkit
   2  *
   3  * Copyright (C) 2003 Sun Microsystems, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Authors:
  21  *      Mark McLoughlin <mark@skynet.ie>
  22  */
  23
  24 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  25 #error "Only <gtk/gtk.h> can be included directly."
  26 #endif
  27
  28 #ifndef __GTK_EXPANDER_H__
  29 #define __GTK_EXPANDER_H__
  30
  31 #include <gtk/gtkbin.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define GTK_TYPE_EXPANDER            (gtk_expander_get_type ())
  36 #define GTK_EXPANDER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_EXPANDER, GtkExpander))
  37 #define GTK_EXPANDER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_EXPANDER, GtkExpanderClass))
  38 #define GTK_IS_EXPANDER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_EXPANDER))
  39 #define GTK_IS_EXPANDER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_EXPANDER))
  40 #define GTK_EXPANDER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_EXPANDER, GtkExpanderClass))
  41
  42 typedef struct _GtkExpander        GtkExpander;
  43 typedef struct _GtkExpanderClass   GtkExpanderClass;
  44 typedef struct _GtkExpanderPrivate GtkExpanderPrivate;
  45
  46 struct _GtkExpander
  47 {
  48   GtkBin              bin;
  49
  50   GtkExpanderPrivate *GSEAL (priv);
  51 };
  52
  53 struct _GtkExpanderClass
  54 {
  55   GtkBinClass    parent_class;
  56
  57   /* Key binding signal; to get notification on the expansion
  58    * state connect to notify:expanded.
  59    */
  60   void        (* activate) (GtkExpander *expander);
  61 };
  62
  63 GType                 gtk_expander_get_type          (void) G_GNUC_CONST;
  64
  65 GtkWidget            *gtk_expander_new               (const gchar *label);
  66 GtkWidget            *gtk_expander_new_with_mnemonic (const gchar *label);
  67
  68 void                  gtk_expander_set_expanded      (GtkExpander *expander,
  69                                                       gboolean     expanded);
  70 gboolean              gtk_expander_get_expanded      (GtkExpander *expander);
  71
  72 /* Spacing between the expander/label and the child */
  73 void                  gtk_expander_set_spacing       (GtkExpander *expander,
  74                                                       gint         spacing);
  75 gint                  gtk_expander_get_spacing       (GtkExpander *expander);
  76
  77 void                  gtk_expander_set_label         (GtkExpander *expander,
  78                                                       const gchar *label);
  79 G_CONST_RETURN gchar *gtk_expander_get_label         (GtkExpander *expander);
  80
  81 void                  gtk_expander_set_use_underline (GtkExpander *expander,
  82                                                       gboolean     use_underline);
  83 gboolean              gtk_expander_get_use_underline (GtkExpander *expander);
  84
  85 void                  gtk_expander_set_use_markup    (GtkExpander *expander,
  86                                                       gboolean    use_markup);
  87 gboolean              gtk_expander_get_use_markup    (GtkExpander *expander);
  88
  89 void                  gtk_expander_set_label_widget  (GtkExpander *expander,
  90                                                       GtkWidget   *label_widget);
  91 GtkWidget            *gtk_expander_get_label_widget  (GtkExpander *expander);
  92
  93 G_END_DECLS
  94
  95 #endif /* __GTK_EXPANDER_H__ */