Pileus Git - ~andy/gtk/blob - gtk/gtkcellareacontext.h

   1 /* gtkcellareacontext.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_CELL_AREA_CONTEXT_H__
  29 #define __GTK_CELL_AREA_CONTEXT_H__
  30
  31 #include <gtk/gtkcellarea.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define GTK_TYPE_CELL_AREA_CONTEXT            (gtk_cell_area_context_get_type ())
  36 #define GTK_CELL_AREA_CONTEXT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContext))
  37 #define GTK_CELL_AREA_CONTEXT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContextClass))
  38 #define GTK_IS_CELL_AREA_CONTEXT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CELL_AREA_CONTEXT))
  39 #define GTK_IS_CELL_AREA_CONTEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CELL_AREA_CONTEXT))
  40 #define GTK_CELL_AREA_CONTEXT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContextClass))
  41
  42 typedef struct _GtkCellAreaContextPrivate       GtkCellAreaContextPrivate;
  43 typedef struct _GtkCellAreaContextClass         GtkCellAreaContextClass;
  44
  45 struct _GtkCellAreaContext
  46 {
  47   GObject parent_instance;
  48
  49   GtkCellAreaContextPrivate *priv;
  50 };
  51
  52 struct _GtkCellAreaContextClass
  53 {
  54   GObjectClass parent_class;
  55
  56   /* Subclasses can use this to flush their alignments/allocations */
  57   void    (* flush_preferred_width)              (GtkCellAreaContext *context);
  58   void    (* flush_preferred_height)             (GtkCellAreaContext *context);
  59   void    (* flush_allocation)                   (GtkCellAreaContext *context);
  60
  61   /* These must be invoked after a series of requests before consulting
  62    * the context values, implementors use this to push the overall
  63    * requests while acconting for any internal alignments */
  64   void    (* sum_preferred_width)                (GtkCellAreaContext *context);
  65   void    (* sum_preferred_height)               (GtkCellAreaContext *context);
  66
  67   /* Store an allocation value for a GtkCellArea contextual to a range of
  68    * treemodel rows */
  69   void    (* allocate)                           (GtkCellAreaContext *context,
  70                                                   gint                width,
  71                                                   gint                height);
  72
  73   /* Padding for future expansion */
  74   void (*_gtk_reserved1) (void);
  75   void (*_gtk_reserved2) (void);
  76   void (*_gtk_reserved3) (void);
  77   void (*_gtk_reserved4) (void);
  78 };
  79
  80 GType        gtk_cell_area_context_get_type                         (void) G_GNUC_CONST;
  81
  82 GtkCellArea *gtk_cell_area_context_get_area                         (GtkCellAreaContext *context);
  83
  84 /* Apis for GtkCellArea clients to flush the cache */
  85 void         gtk_cell_area_context_flush                            (GtkCellAreaContext *context);
  86 void         gtk_cell_area_context_flush_preferred_width            (GtkCellAreaContext *context);
  87 void         gtk_cell_area_context_flush_preferred_height           (GtkCellAreaContext *context);
  88 void         gtk_cell_area_context_flush_allocation                 (GtkCellAreaContext *context);
  89
  90 /* Apis for GtkCellArea clients to sum up the results of a series of requests, this
  91  * call is required to reduce the processing while calculating the size of each row */
  92 void         gtk_cell_area_context_sum_preferred_width              (GtkCellAreaContext *context);
  93 void         gtk_cell_area_context_sum_preferred_height             (GtkCellAreaContext *context);
  94
  95 /* Apis to set an allocation size in one dimension or another, the subclass specific context
  96  * will store allocated positions/sizes for individual cells or groups of cells */
  97 void         gtk_cell_area_context_allocate                         (GtkCellAreaContext *context,
  98                                                                      gint                width,
  99                                                                      gint                height);
 100
 101 /* Apis for GtkCellArea clients to consult cached values for multiple GtkTreeModel rows */
 102 void         gtk_cell_area_context_get_preferred_width              (GtkCellAreaContext *context,
 103                                                                      gint               *minimum_width,
 104                                                                      gint               *natural_width);
 105 void         gtk_cell_area_context_get_preferred_height             (GtkCellAreaContext *context,
 106                                                                      gint               *minimum_height,
 107                                                                      gint               *natural_height);
 108 void         gtk_cell_area_context_get_allocation                   (GtkCellAreaContext *context,
 109                                                                      gint               *width,
 110                                                                      gint               *height);
 111
 112 /* Apis for GtkCellArea implementations to update cached values for multiple GtkTreeModel rows */
 113 void         gtk_cell_area_context_push_preferred_width             (GtkCellAreaContext *context,
 114                                                                      gint                minimum_width,
 115                                                                      gint                natural_width);
 116 void         gtk_cell_area_context_push_preferred_height            (GtkCellAreaContext *context,
 117                                                                      gint                minimum_height,
 118                                                                      gint                natural_height);
 119
 120 G_END_DECLS
 121
 122 #endif /* __GTK_CELL_AREA_CONTEXT_H__ */