Pileus Git - ~andy/gtk/blob - 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, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef __GTK_TREE_MENU_H__
  23 #define __GTK_TREE_MENU_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/gtkmenu.h>
  30 #include <gtk/gtktreemodel.h>
  31 #include <gtk/gtktreeview.h>
  32 #include <gtk/gtkcellarea.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define GTK_TYPE_TREE_MENU                (_gtk_tree_menu_get_type ())
  37 #define GTK_TREE_MENU(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MENU, GtkTreeMenu))
  38 #define GTK_TREE_MENU_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_MENU, GtkTreeMenuClass))
  39 #define GTK_IS_TREE_MENU(obj)     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MENU))
  40 #define GTK_IS_TREE_MENU_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_MENU))
  41 #define GTK_TREE_MENU_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_MENU, GtkTreeMenuClass))
  42
  43 typedef struct _GtkTreeMenu              GtkTreeMenu;
  44 typedef struct _GtkTreeMenuClass         GtkTreeMenuClass;
  45 typedef struct _GtkTreeMenuPrivate       GtkTreeMenuPrivate;
  46
  47 /**
  48  * GtkTreeMenuHeaderFunc:
  49  * @model: a #GtkTreeModel
  50  * @iter: the #GtkTreeIter pointing at a row in @model
  51  * @data: user data
  52  *
  53  * Function type for determining whether the row pointed to by @iter
  54  * which has children should be replicated as a header item in the
  55  * child menu.
  56  *
  57  * Return value: %TRUE if @iter should have an activatable header menu
  58  * item created for it in a submenu.
  59  */
  60 typedef gboolean (*GtkTreeMenuHeaderFunc) (GtkTreeModel      *model,
  61                                            GtkTreeIter       *iter,
  62                                            gpointer           data);
  63
  64 struct _GtkTreeMenu
  65 {
  66   GtkMenu parent_instance;
  67
  68   /*< private >*/
  69   GtkTreeMenuPrivate *priv;
  70 };
  71
  72 struct _GtkTreeMenuClass
  73 {
  74   GtkMenuClass parent_class;
  75
  76   /*< private >*/
  77   /* Padding for future expansion */
  78   void (*_gtk_reserved1) (void);
  79   void (*_gtk_reserved2) (void);
  80   void (*_gtk_reserved3) (void);
  81   void (*_gtk_reserved4) (void);
  82   void (*_gtk_reserved5) (void);
  83   void (*_gtk_reserved6) (void);
  84 };
  85
  86 GType                 _gtk_tree_menu_get_type                       (void) G_GNUC_CONST;
  87
  88 GtkWidget            *_gtk_tree_menu_new                            (void);
  89 GtkWidget            *_gtk_tree_menu_new_with_area                  (GtkCellArea         *area);
  90 GtkWidget            *_gtk_tree_menu_new_full                       (GtkCellArea         *area,
  91                                                                      GtkTreeModel        *model,
  92                                                                      GtkTreePath         *root);
  93 void                  _gtk_tree_menu_set_model                      (GtkTreeMenu         *menu,
  94                                                                      GtkTreeModel        *model);
  95 GtkTreeModel         *_gtk_tree_menu_get_model                      (GtkTreeMenu         *menu);
  96 void                  _gtk_tree_menu_set_root                       (GtkTreeMenu         *menu,
  97                                                                      GtkTreePath         *path);
  98 GtkTreePath          *_gtk_tree_menu_get_root                       (GtkTreeMenu         *menu);
  99 gboolean              _gtk_tree_menu_get_tearoff                    (GtkTreeMenu         *menu);
 100 void                  _gtk_tree_menu_set_tearoff                    (GtkTreeMenu         *menu,
 101                                                                      gboolean             tearoff);
 102 gint                  _gtk_tree_menu_get_wrap_width                 (GtkTreeMenu         *menu);
 103 void                  _gtk_tree_menu_set_wrap_width                 (GtkTreeMenu         *menu,
 104                                                                      gint                 width);
 105 gint                  _gtk_tree_menu_get_row_span_column            (GtkTreeMenu         *menu);
 106 void                  _gtk_tree_menu_set_row_span_column            (GtkTreeMenu         *menu,
 107                                                                      gint                 row_span);
 108 gint                  _gtk_tree_menu_get_column_span_column         (GtkTreeMenu         *menu);
 109 void                  _gtk_tree_menu_set_column_span_column         (GtkTreeMenu         *menu,
 110                                                                      gint                 column_span);
 111
 112 GtkTreeViewRowSeparatorFunc _gtk_tree_menu_get_row_separator_func   (GtkTreeMenu          *menu);
 113 void                        _gtk_tree_menu_set_row_separator_func   (GtkTreeMenu          *menu,
 114                                                                      GtkTreeViewRowSeparatorFunc func,
 115                                                                      gpointer              data,
 116                                                                      GDestroyNotify        destroy);
 117
 118 GtkTreeMenuHeaderFunc _gtk_tree_menu_get_header_func                (GtkTreeMenu          *menu);
 119 void                  _gtk_tree_menu_set_header_func                (GtkTreeMenu          *menu,
 120                                                                      GtkTreeMenuHeaderFunc func,
 121                                                                      gpointer              data,
 122                                                                      GDestroyNotify        destroy);
 123
 124 G_END_DECLS
 125
 126 #endif /* __GTK_TREE_MENU_H__ */