gtkexpander.h 4.87 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15
 *
 * Copyright (C) 2003 Sun Microsystems, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
16
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17 18 19 20 21
 *
 * Authors:
 *	Mark McLoughlin <mark@skynet.ie>
 */

22 23 24
#ifndef __GTK_EXPANDER_H__
#define __GTK_EXPANDER_H__

25
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
26 27 28
#error "Only <gtk/gtk.h> can be included directly."
#endif

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
#include <gtk/gtkbin.h>

G_BEGIN_DECLS

#define GTK_TYPE_EXPANDER            (gtk_expander_get_type ())
#define GTK_EXPANDER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_EXPANDER, GtkExpander))
#define GTK_EXPANDER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_EXPANDER, GtkExpanderClass))
#define GTK_IS_EXPANDER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_EXPANDER))
#define GTK_IS_EXPANDER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_EXPANDER))
#define GTK_EXPANDER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_EXPANDER, GtkExpanderClass))

typedef struct _GtkExpander        GtkExpander;
typedef struct _GtkExpanderClass   GtkExpanderClass;
typedef struct _GtkExpanderPrivate GtkExpanderPrivate;

struct _GtkExpander
{
  GtkBin              bin;

48
  GtkExpanderPrivate *priv;
49 50
};

51 52 53 54 55
/**
 * GtkExpanderClass:
 * @parent_class: The parent class.
 * @activate: Keybinding signal is emitted when the user hits the Enter key.
 */
56 57 58 59
struct _GtkExpanderClass
{
  GtkBinClass    parent_class;

60 61
  /*< public >*/

62 63 64
  /* Key binding signal; to get notification on the expansion
   * state connect to notify:expanded.
   */
65
  void        (* activate) (GtkExpander *expander);
66

67 68
  /*< private >*/

69 70 71 72 73
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
74 75
};

76
GDK_AVAILABLE_IN_ALL
77
GType                 gtk_expander_get_type            (void) G_GNUC_CONST;
78

79
GDK_AVAILABLE_IN_ALL
80
GtkWidget            *gtk_expander_new                 (const gchar *label);
81
GDK_AVAILABLE_IN_ALL
82
GtkWidget            *gtk_expander_new_with_mnemonic   (const gchar *label);
83

84
GDK_AVAILABLE_IN_ALL
85 86
void                  gtk_expander_set_expanded        (GtkExpander *expander,
                                                        gboolean     expanded);
87
GDK_AVAILABLE_IN_ALL
88
gboolean              gtk_expander_get_expanded        (GtkExpander *expander);
89 90

/* Spacing between the expander/label and the child */
91
GDK_AVAILABLE_IN_ALL
92 93
void                  gtk_expander_set_spacing         (GtkExpander *expander,
                                                        gint         spacing);
94
GDK_AVAILABLE_IN_ALL
95 96
gint                  gtk_expander_get_spacing         (GtkExpander *expander);

97
GDK_AVAILABLE_IN_ALL
98 99
void                  gtk_expander_set_label           (GtkExpander *expander,
                                                        const gchar *label);
100
GDK_AVAILABLE_IN_ALL
101
const gchar *         gtk_expander_get_label           (GtkExpander *expander);
102

103
GDK_AVAILABLE_IN_ALL
104 105
void                  gtk_expander_set_use_underline   (GtkExpander *expander,
                                                        gboolean     use_underline);
106
GDK_AVAILABLE_IN_ALL
107 108
gboolean              gtk_expander_get_use_underline   (GtkExpander *expander);

109
GDK_AVAILABLE_IN_ALL
110 111
void                  gtk_expander_set_use_markup      (GtkExpander *expander,
                                                        gboolean    use_markup);
112
GDK_AVAILABLE_IN_ALL
113 114
gboolean              gtk_expander_get_use_markup      (GtkExpander *expander);

115
GDK_AVAILABLE_IN_ALL
116 117
void                  gtk_expander_set_label_widget    (GtkExpander *expander,
						        GtkWidget   *label_widget);
118
GDK_AVAILABLE_IN_ALL
119
GtkWidget            *gtk_expander_get_label_widget    (GtkExpander *expander);
120
GDK_AVAILABLE_IN_ALL
121 122
void                  gtk_expander_set_label_fill      (GtkExpander *expander,
						        gboolean     label_fill);
123
GDK_AVAILABLE_IN_ALL
124
gboolean              gtk_expander_get_label_fill      (GtkExpander *expander);
125
GDK_AVAILABLE_IN_3_2
126 127
void                  gtk_expander_set_resize_toplevel (GtkExpander *expander,
                                                        gboolean     resize_toplevel);
128
GDK_AVAILABLE_IN_3_2
129
gboolean              gtk_expander_get_resize_toplevel (GtkExpander *expander);
130 131 132 133

G_END_DECLS

#endif /* __GTK_EXPANDER_H__ */