gtkcellareacontext.h 7.18 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/* 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
Javier Jardon's avatar
Javier Jardon committed
19
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
20 21
 */

22 23 24
#ifndef __GTK_CELL_AREA_CONTEXT_H__
#define __GTK_CELL_AREA_CONTEXT_H__

25 26 27 28 29 30 31 32
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

#include <gtk/gtkcellarea.h>

G_BEGIN_DECLS

Matthias Clasen's avatar
Matthias Clasen committed
33 34
#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))
35
#define GTK_CELL_AREA_CONTEXT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CELL_AREA_CONTEXT, GtkCellAreaContextClass))
Matthias Clasen's avatar
Matthias Clasen committed
36
#define GTK_IS_CELL_AREA_CONTEXT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CELL_AREA_CONTEXT))
37 38 39 40 41 42 43 44
#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
{
45
  /*< private >*/
46 47 48 49 50
  GObject parent_instance;

  GtkCellAreaContextPrivate *priv;
};

51 52
/**
 * GtkCellAreaContextClass:
Matthias Clasen's avatar
Matthias Clasen committed
53 54 55 56 57 58 59
 * @allocate: This tells the context that an allocation width or height
 *     (or both) have been decided for a group of rows. The context should
 *     store any allocations for internally aligned cells at this point so
 *     that they dont need to be recalculated at gtk_cell_area_render() time.
 * @reset: Clear any previously stored information about requested and
 *     allocated sizes for the context.
 * @get_preferred_height_for_width: Returns the aligned height for the given
60
 *     width that context must store while collecting sizes for it’s rows.
Matthias Clasen's avatar
Matthias Clasen committed
61
 * @get_preferred_width_for_height: Returns the aligned width for the given
62
 *     height that context must store while collecting sizes for it’s rows.
63
 */
64 65
struct _GtkCellAreaContextClass
{
66
  /*< private >*/
67 68
  GObjectClass parent_class;

69
  /*< public >*/
70
  void    (* allocate)                       (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
71 72
                                              gint                width,
                                              gint                height);
73 74
  void    (* reset)                          (GtkCellAreaContext *context);
  void    (* get_preferred_height_for_width) (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
75 76 77
                                              gint                width,
                                              gint               *minimum_height,
                                              gint               *natural_height);
78
  void    (* get_preferred_width_for_height) (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
79 80 81
                                              gint                height,
                                              gint               *minimum_width,
                                              gint               *natural_width);
82

83
  /*< private >*/
84 85 86 87 88
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
89 90
  void (*_gtk_reserved5) (void);
  void (*_gtk_reserved6) (void);
91 92
};

93
GDK_AVAILABLE_IN_ALL
94 95 96
GType        gtk_cell_area_context_get_type              (void) G_GNUC_CONST;

/* Main apis */
97
GDK_AVAILABLE_IN_ALL
98
GtkCellArea *gtk_cell_area_context_get_area                        (GtkCellAreaContext *context);
99
GDK_AVAILABLE_IN_ALL
100
void         gtk_cell_area_context_allocate                        (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
101 102
                                                                    gint                width,
                                                                    gint                height);
103
GDK_AVAILABLE_IN_ALL
104
void         gtk_cell_area_context_reset                           (GtkCellAreaContext *context);
105

Matthias Clasen's avatar
Matthias Clasen committed
106 107 108
/* Apis for GtkCellArea clients to consult cached values
 * for a series of GtkTreeModel rows
 */
109
GDK_AVAILABLE_IN_ALL
110
void         gtk_cell_area_context_get_preferred_width            (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
111 112
                                                                   gint               *minimum_width,
                                                                   gint               *natural_width);
113
GDK_AVAILABLE_IN_ALL
114
void         gtk_cell_area_context_get_preferred_height           (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
115 116
                                                                   gint               *minimum_height,
                                                                   gint               *natural_height);
117
GDK_AVAILABLE_IN_ALL
118
void         gtk_cell_area_context_get_preferred_height_for_width (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
119 120 121
                                                                   gint                width,
                                                                   gint               *minimum_height,
                                                                   gint               *natural_height);
122
GDK_AVAILABLE_IN_ALL
123
void         gtk_cell_area_context_get_preferred_width_for_height (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
124 125 126
                                                                   gint                height,
                                                                   gint               *minimum_width,
                                                                   gint               *natural_width);
127
GDK_AVAILABLE_IN_ALL
128
void         gtk_cell_area_context_get_allocation                 (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
129 130
                                                                   gint               *width,
                                                                   gint               *height);
131

Matthias Clasen's avatar
Matthias Clasen committed
132 133 134
/* Apis for GtkCellArea implementations to update cached values
 * for multiple GtkTreeModel rows
 */
135
GDK_AVAILABLE_IN_ALL
136
void         gtk_cell_area_context_push_preferred_width  (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
137 138
                                                          gint                minimum_width,
                                                          gint                natural_width);
139
GDK_AVAILABLE_IN_ALL
140
void         gtk_cell_area_context_push_preferred_height (GtkCellAreaContext *context,
Matthias Clasen's avatar
Matthias Clasen committed
141 142
                                                          gint                minimum_height,
                                                          gint                natural_height);
143 144 145 146

G_END_DECLS

#endif /* __GTK_CELL_AREA_CONTEXT_H__ */