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, 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 /**
  50  * GtkTreeMenuHeaderFunc:
  51  * @model: a #GtkTreeModel
  52  * @iter: the #GtkTreeIter pointing at a row in @model
  53  * @data: user data
  54  *
  55  * Function type for determining whether the row pointed to by @iter
  56  * which has children should be replicated as a header item in the
  57  * child menu.
  58  *
  59  * Return value: %TRUE if @iter should have an activatable header menu
  60  * item created for it in a submenu.
  61  */
  62 typedef gboolean (*GtkTreeMenuHeaderFunc) (GtkTreeModel      *model,
  63                                            GtkTreeIter       *iter,
  64                                            gpointer           data);
  65
  66 struct _GtkTreeMenu
  67 {
  68   GtkMenu parent_instance;
  69
  70   /*< private >*/
  71   GtkTreeMenuPrivate *priv;
  72 };
  73
  74 struct _GtkTreeMenuClass
  75 {
  76   GtkMenuClass parent_class;
  77
  78   /*< private >*/
  79   /* Padding for future expansion */
  80   void (*_gtk_reserved1) (void);
  81   void (*_gtk_reserved2) (void);
  82   void (*_gtk_reserved3) (void);
  83   void (*_gtk_reserved4) (void);
  84   void (*_gtk_reserved5) (void);
  85   void (*_gtk_reserved6) (void);
  86 };
  87
  88 GType                 _gtk_tree_menu_get_type                       (void) G_GNUC_CONST;
  89
  90 GtkWidget            *_gtk_tree_menu_new                            (void);
  91 GtkWidget            *_gtk_tree_menu_new_with_area                  (GtkCellArea         *area);
  92 GtkWidget            *_gtk_tree_menu_new_full                       (GtkCellArea         *area,
  93                                                                      GtkTreeModel        *model,
  94                                                                      GtkTreePath         *root);
  95 void                  _gtk_tree_menu_set_model                      (GtkTreeMenu         *menu,
  96                                                                      GtkTreeModel        *model);
  97 GtkTreeModel         *_gtk_tree_menu_get_model                      (GtkTreeMenu         *menu);
  98 void                  _gtk_tree_menu_set_root                       (GtkTreeMenu         *menu,
  99                                                                      GtkTreePath         *path);
 100 GtkTreePath          *_gtk_tree_menu_get_root                       (GtkTreeMenu         *menu);
 101 gboolean              _gtk_tree_menu_get_tearoff                    (GtkTreeMenu         *menu);
 102 void                  _gtk_tree_menu_set_tearoff                    (GtkTreeMenu         *menu,
 103                                                                      gboolean             tearoff);
 104 gint                  _gtk_tree_menu_get_wrap_width                 (GtkTreeMenu         *menu);
 105 void                  _gtk_tree_menu_set_wrap_width                 (GtkTreeMenu         *menu,
 106                                                                      gint                 width);
 107 gint                  _gtk_tree_menu_get_row_span_column            (GtkTreeMenu         *menu);
 108 void                  _gtk_tree_menu_set_row_span_column            (GtkTreeMenu         *menu,
 109                                                                      gint                 row_span);
 110 gint                  _gtk_tree_menu_get_column_span_column         (GtkTreeMenu         *menu);
 111 void                  _gtk_tree_menu_set_column_span_column         (GtkTreeMenu         *menu,
 112                                                                      gint                 column_span);
 113
 114 GtkTreeViewRowSeparatorFunc _gtk_tree_menu_get_row_separator_func   (GtkTreeMenu          *menu);
 115 void                        _gtk_tree_menu_set_row_separator_func   (GtkTreeMenu          *menu,
 116                                                                      GtkTreeViewRowSeparatorFunc func,
 117                                                                      gpointer              data,
 118                                                                      GDestroyNotify        destroy);
 119
 120 GtkTreeMenuHeaderFunc _gtk_tree_menu_get_header_func                (GtkTreeMenu          *menu);
 121 void                  _gtk_tree_menu_set_header_func                (GtkTreeMenu          *menu,
 122                                                                      GtkTreeMenuHeaderFunc func,
 123                                                                      gpointer              data,
 124                                                                      GDestroyNotify        destroy);
 125
 126 G_END_DECLS
 127
 128 #endif /* __GTK_TREE_MENU_H__ */