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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
/* ctkcellrenderer.h
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.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, see <http://www.gnu.org/licenses/>.
 */

#ifndef __CTK_CELL_RENDERER_H__
#define __CTK_CELL_RENDERER_H__

#if !defined (__CTK_H_INSIDE__) && !defined (CTK_COMPILATION)
#error "Only <ctk/ctk.h> can be included directly."
#endif

#include <ctk/ctkcelleditable.h>

G_BEGIN_DECLS


/**
 * CtkCellRendererState:
 * @CTK_CELL_RENDERER_SELECTED: The cell is currently selected, and
 *  probably has a selection colored background to render to.
 * @CTK_CELL_RENDERER_PRELIT: The mouse is hovering over the cell.
 * @CTK_CELL_RENDERER_INSENSITIVE: The cell is drawn in an insensitive manner
 * @CTK_CELL_RENDERER_SORTED: The cell is in a sorted row
 * @CTK_CELL_RENDERER_FOCUSED: The cell is in the focus row.
 * @CTK_CELL_RENDERER_EXPANDABLE: The cell is in a row that can be expanded. Since 3.4
 * @CTK_CELL_RENDERER_EXPANDED: The cell is in a row that is expanded. Since 3.4
 *
 * Tells how a cell is to be rendered.
 */
typedef enum
{
  CTK_CELL_RENDERER_SELECTED    = 1 << 0,
  CTK_CELL_RENDERER_PRELIT      = 1 << 1,
  CTK_CELL_RENDERER_INSENSITIVE = 1 << 2,
  /* this flag means the cell is in the sort column/row */
  CTK_CELL_RENDERER_SORTED      = 1 << 3,
  CTK_CELL_RENDERER_FOCUSED     = 1 << 4,
  CTK_CELL_RENDERER_EXPANDABLE  = 1 << 5,
  CTK_CELL_RENDERER_EXPANDED    = 1 << 6
} CtkCellRendererState;

/**
 * CtkCellRendererMode:
 * @CTK_CELL_RENDERER_MODE_INERT: The cell is just for display
 *  and cannot be interacted with.  Note that this doesn’t mean that eg. the
 *  row being drawn can’t be selected -- just that a particular element of
 *  it cannot be individually modified.
 * @CTK_CELL_RENDERER_MODE_ACTIVATABLE: The cell can be clicked.
 * @CTK_CELL_RENDERER_MODE_EDITABLE: The cell can be edited or otherwise modified.
 *
 * Identifies how the user can interact with a particular cell.
 */
typedef enum
{
  CTK_CELL_RENDERER_MODE_INERT,
  CTK_CELL_RENDERER_MODE_ACTIVATABLE,
  CTK_CELL_RENDERER_MODE_EDITABLE
} CtkCellRendererMode;

#define CTK_TYPE_CELL_RENDERER		  (ctk_cell_renderer_get_type ())
#define CTK_CELL_RENDERER(obj)		  (G_TYPE_CHECK_INSTANCE_CAST ((obj), CTK_TYPE_CELL_RENDERER, CtkCellRenderer))
#define CTK_CELL_RENDERER_CLASS(klass)	  (G_TYPE_CHECK_CLASS_CAST ((klass), CTK_TYPE_CELL_RENDERER, CtkCellRendererClass))
#define CTK_IS_CELL_RENDERER(obj)	  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CTK_TYPE_CELL_RENDERER))
#define CTK_IS_CELL_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CTK_TYPE_CELL_RENDERER))
#define CTK_CELL_RENDERER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), CTK_TYPE_CELL_RENDERER, CtkCellRendererClass))

typedef struct _CtkCellRenderer              CtkCellRenderer;
typedef struct _CtkCellRendererPrivate       CtkCellRendererPrivate;
typedef struct _CtkCellRendererClass         CtkCellRendererClass;
typedef struct _CtkCellRendererClassPrivate  CtkCellRendererClassPrivate;

struct _CtkCellRenderer
{
  GInitiallyUnowned parent_instance;

  /*< private >*/
  CtkCellRendererPrivate *priv;
};

/**
 * CtkCellRendererClass:
 * @get_request_mode: Called to gets whether the cell renderer prefers
 *    a height-for-width layout or a width-for-height layout.
 * @get_preferred_width: Called to get a renderer’s natural width.
 * @get_preferred_height_for_width: Called to get a renderer’s natural height for width.
 * @get_preferred_height: Called to get a renderer’s natural height.
 * @get_preferred_width_for_height: Called to get a renderer’s natural width for height.
 * @get_aligned_area: Called to get the aligned area used by @cell inside @cell_area.
 * @get_size: Called to get the width and height needed to render the cell. Deprecated: 3.0.
 * @render: Called to render the content of the #CtkCellRenderer.
 * @activate: Called to activate the content of the #CtkCellRenderer.
 * @start_editing: Called to initiate editing the content of the #CtkCellRenderer.
 * @editing_canceled: Signal gets emitted when the user cancels the process of editing a cell.
 * @editing_started: Signal gets emitted when a cell starts to be edited.
 */
struct _CtkCellRendererClass
{
  /*< private >*/
  GInitiallyUnownedClass parent_class;

  /*< public >*/

  /* vtable - not signals */
  CtkSizeRequestMode (* get_request_mode)                (CtkCellRenderer      *cell);
  void               (* get_preferred_width)             (CtkCellRenderer      *cell,
                                                          CtkWidget            *widget,
                                                          gint                 *minimum_size,
                                                          gint                 *natural_size);
  void               (* get_preferred_height_for_width)  (CtkCellRenderer      *cell,
                                                          CtkWidget            *widget,
                                                          gint                  width,
                                                          gint                 *minimum_height,
                                                          gint                 *natural_height);
  void               (* get_preferred_height)            (CtkCellRenderer      *cell,
                                                          CtkWidget            *widget,
                                                          gint                 *minimum_size,
                                                          gint                 *natural_size);
  void               (* get_preferred_width_for_height)  (CtkCellRenderer      *cell,
                                                          CtkWidget            *widget,
                                                          gint                  height,
                                                          gint                 *minimum_width,
                                                          gint                 *natural_width);
  void               (* get_aligned_area)                (CtkCellRenderer      *cell,
                                                          CtkWidget            *widget,
							  CtkCellRendererState  flags,
                                                          const CdkRectangle   *cell_area,
                                                          CdkRectangle         *aligned_area);
  void               (* get_size)                        (CtkCellRenderer      *cell,
                                                          CtkWidget            *widget,
                                                          const CdkRectangle   *cell_area,
                                                          gint                 *x_offset,
                                                          gint                 *y_offset,
                                                          gint                 *width,
                                                          gint                 *height);
  void               (* render)                          (CtkCellRenderer      *cell,
                                                          cairo_t              *cr,
                                                          CtkWidget            *widget,
                                                          const CdkRectangle   *background_area,
                                                          const CdkRectangle   *cell_area,
                                                          CtkCellRendererState  flags);
  gboolean           (* activate)                        (CtkCellRenderer      *cell,
                                                          CdkEvent             *event,
                                                          CtkWidget            *widget,
                                                          const gchar          *path,
                                                          const CdkRectangle   *background_area,
                                                          const CdkRectangle   *cell_area,
                                                          CtkCellRendererState  flags);
  CtkCellEditable *  (* start_editing)                   (CtkCellRenderer      *cell,
                                                          CdkEvent             *event,
                                                          CtkWidget            *widget,
                                                          const gchar          *path,
                                                          const CdkRectangle   *background_area,
                                                          const CdkRectangle   *cell_area,
                                                          CtkCellRendererState  flags);

  /* Signals */
  void (* editing_canceled) (CtkCellRenderer *cell);
  void (* editing_started)  (CtkCellRenderer *cell,
			     CtkCellEditable *editable,
			     const gchar     *path);

  /*< private >*/

  CtkCellRendererClassPrivate *priv;

  /* Padding for future expansion */
  void (*_ctk_reserved2) (void);
  void (*_ctk_reserved3) (void);
  void (*_ctk_reserved4) (void);
};

CDK_AVAILABLE_IN_ALL
GType              ctk_cell_renderer_get_type       (void) G_GNUC_CONST;

CDK_AVAILABLE_IN_ALL
CtkSizeRequestMode ctk_cell_renderer_get_request_mode               (CtkCellRenderer    *cell);
CDK_AVAILABLE_IN_ALL
void               ctk_cell_renderer_get_preferred_width            (CtkCellRenderer    *cell,
                                                                     CtkWidget          *widget,
                                                                     gint               *minimum_size,
                                                                     gint               *natural_size);
CDK_AVAILABLE_IN_ALL
void               ctk_cell_renderer_get_preferred_height_for_width (CtkCellRenderer    *cell,
                                                                     CtkWidget          *widget,
                                                                     gint                width,
                                                                     gint               *minimum_height,
                                                                     gint               *natural_height);
CDK_AVAILABLE_IN_ALL
void               ctk_cell_renderer_get_preferred_height           (CtkCellRenderer    *cell,
                                                                     CtkWidget          *widget,
                                                                     gint               *minimum_size,
                                                                     gint               *natural_size);
CDK_AVAILABLE_IN_ALL
void               ctk_cell_renderer_get_preferred_width_for_height (CtkCellRenderer    *cell,
                                                                     CtkWidget          *widget,
                                                                     gint                height,
                                                                     gint               *minimum_width,
                                                                     gint               *natural_width);
CDK_AVAILABLE_IN_ALL
void               ctk_cell_renderer_get_preferred_size             (CtkCellRenderer    *cell,
                                                                     CtkWidget          *widget,
                                                                     CtkRequisition     *minimum_size,
                                                                     CtkRequisition     *natural_size);
CDK_AVAILABLE_IN_ALL
void               ctk_cell_renderer_get_aligned_area               (CtkCellRenderer    *cell,
								     CtkWidget          *widget,
								     CtkCellRendererState flags,
								     const CdkRectangle *cell_area,
								     CdkRectangle       *aligned_area);

CDK_DEPRECATED_IN_3_0_FOR(ctk_cell_renderer_get_preferred_size)<--- There is an unknown macro here somewhere. Configuration is required. If CDK_DEPRECATED_IN_3_0_FOR is a macro then please configure it.
void             ctk_cell_renderer_get_size       (CtkCellRenderer      *cell,
                                                   CtkWidget            *widget,
                                                   const CdkRectangle   *cell_area,
                                                   gint                 *x_offset,
                                                   gint                 *y_offset,
                                                   gint                 *width,
                                                   gint                 *height);
CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_render         (CtkCellRenderer      *cell,
                                                   cairo_t              *cr,
						   CtkWidget            *widget,
						   const CdkRectangle   *background_area,
						   const CdkRectangle   *cell_area,
						   CtkCellRendererState  flags);
CDK_AVAILABLE_IN_ALL
gboolean         ctk_cell_renderer_activate       (CtkCellRenderer      *cell,
						   CdkEvent             *event,
						   CtkWidget            *widget,
						   const gchar          *path,
						   const CdkRectangle   *background_area,
						   const CdkRectangle   *cell_area,
						   CtkCellRendererState  flags);
CDK_AVAILABLE_IN_ALL
CtkCellEditable *ctk_cell_renderer_start_editing  (CtkCellRenderer      *cell,
						   CdkEvent             *event,
						   CtkWidget            *widget,
						   const gchar          *path,
						   const CdkRectangle   *background_area,
						   const CdkRectangle   *cell_area,
						   CtkCellRendererState  flags);

CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_set_fixed_size (CtkCellRenderer      *cell,
						   gint                  width,
						   gint                  height);
CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_get_fixed_size (CtkCellRenderer      *cell,
						   gint                 *width,
						   gint                 *height);

CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_set_alignment  (CtkCellRenderer      *cell,
                                                   gfloat                xalign,
                                                   gfloat                yalign);
CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_get_alignment  (CtkCellRenderer      *cell,
                                                   gfloat               *xalign,
                                                   gfloat               *yalign);

CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_set_padding    (CtkCellRenderer      *cell,
                                                   gint                  xpad,
                                                   gint                  ypad);
CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_get_padding    (CtkCellRenderer      *cell,
                                                   gint                 *xpad,
                                                   gint                 *ypad);

CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_set_visible    (CtkCellRenderer      *cell,
                                                   gboolean              visible);
CDK_AVAILABLE_IN_ALL
gboolean         ctk_cell_renderer_get_visible    (CtkCellRenderer      *cell);

CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_set_sensitive  (CtkCellRenderer      *cell,
                                                   gboolean              sensitive);
CDK_AVAILABLE_IN_ALL
gboolean         ctk_cell_renderer_get_sensitive  (CtkCellRenderer      *cell);

CDK_AVAILABLE_IN_ALL
gboolean         ctk_cell_renderer_is_activatable (CtkCellRenderer      *cell);

/* For use by cell renderer implementations only */
CDK_AVAILABLE_IN_ALL
void             ctk_cell_renderer_stop_editing   (CtkCellRenderer      *cell,
                                                   gboolean              canceled);


void            _ctk_cell_renderer_calc_offset    (CtkCellRenderer      *cell,
                                                   const CdkRectangle   *cell_area,
                                                   CtkTextDirection      direction,
                                                   gint                  width,
                                                   gint                  height,
                                                   gint                 *x_offset,
                                                   gint                 *y_offset);

CDK_AVAILABLE_IN_ALL
CtkStateFlags   ctk_cell_renderer_get_state       (CtkCellRenderer      *cell,
                                                   CtkWidget            *widget,
                                                   CtkCellRendererState  cell_state);

CDK_AVAILABLE_IN_ALL
void            ctk_cell_renderer_class_set_accessible_type 
                                                  (CtkCellRendererClass *renderer_class,
                                                   GType                 type);
GType           _ctk_cell_renderer_get_accessible_type
                                                  (CtkCellRenderer *     renderer);

G_END_DECLS

#endif /* __CTK_CELL_RENDERER_H__ */