summaryrefslogtreecommitdiff
path: root/gtk/gtkcellareacontext.h
blob: 0782f7836489cfeb1d09a0203207ee48ba40af2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/* gtkcellareacontext.h
 *
 * Copyright (C) 2010 Openismus GmbH
 *
 * Authors:
 *      Tristan Van Berkom <tristanvb@openismus.com>
 *
 * 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
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

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

#ifndef __GTK_CELL_AREA_CONTEXT_H__
#define __GTK_CELL_AREA_CONTEXT_H__

#include <gtk/gtkcellarea.h>

G_BEGIN_DECLS

#define GTK_TYPE_CELL_AREA_CONTEXT    	      (gtk_cell_area_context_get_type ())
#define GTK_CELL_AREA_CONTEXT(obj)	      (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContext))
#define GTK_CELL_AREA_CONTEXT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContextClass))
#define GTK_IS_CELL_AREA_CONTEXT(obj)	      (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CELL_AREA_CONTEXT))
#define GTK_IS_CELL_AREA_CONTEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CELL_AREA_CONTEXT))
#define GTK_CELL_AREA_CONTEXT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContextClass))

typedef struct _GtkCellAreaContextPrivate       GtkCellAreaContextPrivate;
typedef struct _GtkCellAreaContextClass         GtkCellAreaContextClass;

struct _GtkCellAreaContext
{
  GObject parent_instance;

  GtkCellAreaContextPrivate *priv;
};

struct _GtkCellAreaContextClass
{
  GObjectClass parent_class;

  /* Subclasses can use this to flush their alignments/allocations */
  void    (* flush_preferred_width)              (GtkCellAreaContext *context);
  void    (* flush_preferred_height)             (GtkCellAreaContext *context);
  void    (* flush_allocation)                   (GtkCellAreaContext *context);

  /* These must be invoked after a series of requests before consulting 
   * the context values, implementors use this to push the overall
   * requests while acconting for any internal alignments */
  void    (* sum_preferred_width)                (GtkCellAreaContext *context);
  void    (* sum_preferred_height)               (GtkCellAreaContext *context);

  /* Store an allocation value for a GtkCellArea contextual to a range of
   * treemodel rows */
  void    (* allocate_width)                     (GtkCellAreaContext *context,
						  gint                width);
  void    (* allocate_height)                    (GtkCellAreaContext *context,
						  gint                height);

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
};

GType        gtk_cell_area_context_get_type                         (void) G_GNUC_CONST;

GtkCellArea *gtk_cell_area_context_get_area                         (GtkCellAreaContext *context);

/* Apis for GtkCellArea clients to flush the cache */
void         gtk_cell_area_context_flush                            (GtkCellAreaContext *context);
void         gtk_cell_area_context_flush_preferred_width            (GtkCellAreaContext *context);
void         gtk_cell_area_context_flush_preferred_height           (GtkCellAreaContext *context);
void         gtk_cell_area_context_flush_allocation                 (GtkCellAreaContext *context);

/* Apis for GtkCellArea clients to sum up the results of a series of requests, this
 * call is required to reduce the processing while calculating the size of each row */
void         gtk_cell_area_context_sum_preferred_width              (GtkCellAreaContext *context);
void         gtk_cell_area_context_sum_preferred_height             (GtkCellAreaContext *context);

/* Apis to set an allocation size in one dimension or another, the subclass specific context
 * will store allocated positions/sizes for individual cells or groups of cells */
void         gtk_cell_area_context_allocate_width                   (GtkCellAreaContext *context,
								     gint                width);
void         gtk_cell_area_context_allocate_height                  (GtkCellAreaContext *context,
								     gint                height);

/* Apis for GtkCellArea clients to consult cached values for multiple GtkTreeModel rows */
void         gtk_cell_area_context_get_preferred_width              (GtkCellAreaContext *context,
								     gint               *minimum_width,
								     gint               *natural_width);
void         gtk_cell_area_context_get_preferred_height             (GtkCellAreaContext *context,
								     gint               *minimum_height,
								     gint               *natural_height);
void         gtk_cell_area_context_get_allocation                   (GtkCellAreaContext *context,
								     gint               *width,
								     gint               *height);

/* Apis for GtkCellArea implementations to update cached values for multiple GtkTreeModel rows */
void         gtk_cell_area_context_push_preferred_width             (GtkCellAreaContext *context,
								     gint                minimum_width,
								     gint                natural_width);
void         gtk_cell_area_context_push_preferred_height            (GtkCellAreaContext *context,
								     gint                minimum_height,
								     gint                natural_height);

G_END_DECLS

#endif /* __GTK_CELL_AREA_CONTEXT_H__ */