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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Authors:
  19  *      Mark McLoughlin <mark@skynet.ie>
  20  */
  21
  22 #ifndef __GTK_EXPANDER_H__
  23 #define __GTK_EXPANDER_H__
  24
  25 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  26 #error "Only <gtk/gtk.h> can be included directly."
  27 #endif
  28
  29 #include <gtk/gtkbin.h>
  30
  31 G_BEGIN_DECLS
  32
  33 #define GTK_TYPE_EXPANDER            (gtk_expander_get_type ())
  34 #define GTK_EXPANDER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_EXPANDER, GtkExpander))
  35 #define GTK_EXPANDER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_EXPANDER, GtkExpanderClass))
  36 #define GTK_IS_EXPANDER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_EXPANDER))
  37 #define GTK_IS_EXPANDER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_EXPANDER))
  38 #define GTK_EXPANDER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_EXPANDER, GtkExpanderClass))
  39
  40 typedef struct _GtkExpander        GtkExpander;
  41 typedef struct _GtkExpanderClass   GtkExpanderClass;
  42 typedef struct _GtkExpanderPrivate GtkExpanderPrivate;
  43
  44 struct _GtkExpander
  45 {
  46   GtkBin              bin;
  47
  48   GtkExpanderPrivate *priv;
  49 };
  50
  51 struct _GtkExpanderClass
  52 {
  53   GtkBinClass    parent_class;
  54
  55   /* Key binding signal; to get notification on the expansion
  56    * state connect to notify:expanded.
  57    */
  58   void        (* activate) (GtkExpander *expander);
  59
  60   /* Padding for future expansion */
  61   void (*_gtk_reserved1) (void);
  62   void (*_gtk_reserved2) (void);
  63   void (*_gtk_reserved3) (void);
  64   void (*_gtk_reserved4) (void);
  65 };
  66
  67 GType                 gtk_expander_get_type            (void) G_GNUC_CONST;
  68
  69 GtkWidget            *gtk_expander_new                 (const gchar *label);
  70 GtkWidget            *gtk_expander_new_with_mnemonic   (const gchar *label);
  71
  72 void                  gtk_expander_set_expanded        (GtkExpander *expander,
  73                                                         gboolean     expanded);
  74 gboolean              gtk_expander_get_expanded        (GtkExpander *expander);
  75
  76 /* Spacing between the expander/label and the child */
  77 void                  gtk_expander_set_spacing         (GtkExpander *expander,
  78                                                         gint         spacing);
  79 gint                  gtk_expander_get_spacing         (GtkExpander *expander);
  80
  81 void                  gtk_expander_set_label           (GtkExpander *expander,
  82                                                         const gchar *label);
  83 const gchar *         gtk_expander_get_label           (GtkExpander *expander);
  84
  85 void                  gtk_expander_set_use_underline   (GtkExpander *expander,
  86                                                         gboolean     use_underline);
  87 gboolean              gtk_expander_get_use_underline   (GtkExpander *expander);
  88
  89 void                  gtk_expander_set_use_markup      (GtkExpander *expander,
  90                                                         gboolean    use_markup);
  91 gboolean              gtk_expander_get_use_markup      (GtkExpander *expander);
  92
  93 void                  gtk_expander_set_label_widget    (GtkExpander *expander,
  94                                                         GtkWidget   *label_widget);
  95 GtkWidget            *gtk_expander_get_label_widget    (GtkExpander *expander);
  96 void                  gtk_expander_set_label_fill      (GtkExpander *expander,
  97                                                         gboolean     label_fill);
  98 gboolean              gtk_expander_get_label_fill      (GtkExpander *expander);
  99 GDK_AVAILABLE_IN_3_2
 100 void                  gtk_expander_set_resize_toplevel (GtkExpander *expander,
 101                                                         gboolean     resize_toplevel);
 102 GDK_AVAILABLE_IN_3_2
 103 gboolean              gtk_expander_get_resize_toplevel (GtkExpander *expander);
 104
 105 G_END_DECLS
 106
 107 #endif /* __GTK_EXPANDER_H__ */