]> Pileus Git - ~andy/gtk/blob - gtk/gtktreemenu.h
Added GtkTreeMenuHeaderFunc to decide if a submenu gets a leaf header.
[~andy/gtk] / gtk / gtktreemenu.h
1 /* gtktreemenu.h
2  *
3  * Copyright (C) 2010 Openismus GmbH
4  *
5  * Authors:
6  *      Tristan Van Berkom <tristanvb@openismus.com>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
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_TREE_MENU_H__
29 #define __GTK_TREE_MENU_H__
30
31 #include <gtk/gtkmenu.h>
32 #include <gtk/gtktreemodel.h>
33 #include <gtk/gtktreeview.h>
34 #include <gtk/gtkcellarea.h>
35
36 G_BEGIN_DECLS
37
38 #define GTK_TYPE_TREE_MENU                (gtk_tree_menu_get_type ())
39 #define GTK_TREE_MENU(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MENU, GtkTreeMenu))
40 #define GTK_TREE_MENU_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_MENU, GtkTreeMenuClass))
41 #define GTK_IS_TREE_MENU(obj)     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MENU))
42 #define GTK_IS_TREE_MENU_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_MENU))
43 #define GTK_TREE_MENU_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_MENU, GtkTreeMenuClass))
44
45 typedef struct _GtkTreeMenu              GtkTreeMenu;
46 typedef struct _GtkTreeMenuClass         GtkTreeMenuClass;
47 typedef struct _GtkTreeMenuPrivate       GtkTreeMenuPrivate;
48
49 typedef gboolean (*GtkTreeMenuHeaderFunc) (GtkTreeModel      *model,
50                                            GtkTreeIter       *iter,
51                                            gpointer           data);
52
53 struct _GtkTreeMenu
54 {
55   GtkMenu parent_instance;
56
57   GtkTreeMenuPrivate *priv;
58 };
59
60 struct _GtkTreeMenuClass
61 {
62   GtkMenuClass parent_class;
63
64   /* Padding for future expansion */
65   void (*_gtk_reserved1) (void);
66   void (*_gtk_reserved2) (void);
67   void (*_gtk_reserved3) (void);
68   void (*_gtk_reserved4) (void);
69   void (*_gtk_reserved5) (void);
70   void (*_gtk_reserved6) (void);
71   void (*_gtk_reserved7) (void);
72   void (*_gtk_reserved8) (void);
73 };
74
75 GType                 gtk_tree_menu_get_type                       (void) G_GNUC_CONST;
76
77 GtkWidget            *gtk_tree_menu_new                            (void);
78 GtkWidget            *gtk_tree_menu_new_with_area                  (GtkCellArea         *area);
79 GtkWidget            *gtk_tree_menu_new_full                       (GtkCellArea         *area,
80                                                                     GtkTreeModel        *model,
81                                                                     GtkTreePath         *root);
82 void                  gtk_tree_menu_set_model                      (GtkTreeMenu         *menu,
83                                                                     GtkTreeModel        *model);
84 GtkTreeModel         *gtk_tree_menu_get_model                      (GtkTreeMenu         *menu);
85 void                  gtk_tree_menu_set_root                       (GtkTreeMenu         *menu,
86                                                                     GtkTreePath         *path);
87 GtkTreePath          *gtk_tree_menu_get_root                       (GtkTreeMenu         *menu);
88
89 void                        gtk_tree_menu_set_row_separator_func   (GtkTreeMenu          *menu,
90                                                                     GtkTreeViewRowSeparatorFunc func,
91                                                                     gpointer              data,
92                                                                     GDestroyNotify        destroy);
93 GtkTreeViewRowSeparatorFunc gtk_tree_menu_get_row_separator_func   (GtkTreeMenu          *menu);
94
95 void                  gtk_tree_menu_set_header_func                (GtkTreeMenu          *menu,
96                                                                     GtkTreeMenuHeaderFunc func,
97                                                                     gpointer              data,
98                                                                     GDestroyNotify        destroy);
99 GtkTreeMenuHeaderFunc gtk_tree_menu_get_header_func                (GtkTreeMenu          *menu);
100
101 G_END_DECLS
102
103 #endif /* __GTK_TREE_MENU_H__ */