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

   1 /* gtkcellrenderer.h
   2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_CELL_RENDERER_H__
  25 #define __GTK_CELL_RENDERER_H__
  26
  27 #include <gtk/gtkcelleditable.h>
  28
  29 G_BEGIN_DECLS
  30
  31 typedef enum
  32 {
  33   GTK_CELL_RENDERER_SELECTED    = 1 << 0,
  34   GTK_CELL_RENDERER_PRELIT      = 1 << 1,
  35   GTK_CELL_RENDERER_INSENSITIVE = 1 << 2,
  36   /* this flag means the cell is in the sort column/row */
  37   GTK_CELL_RENDERER_SORTED      = 1 << 3,
  38   GTK_CELL_RENDERER_FOCUSED     = 1 << 4
  39 } GtkCellRendererState;
  40
  41 typedef enum
  42 {
  43   GTK_CELL_RENDERER_MODE_INERT,
  44   GTK_CELL_RENDERER_MODE_ACTIVATABLE,
  45   GTK_CELL_RENDERER_MODE_EDITABLE
  46 } GtkCellRendererMode;
  47
  48 #define GTK_TYPE_CELL_RENDERER            (gtk_cell_renderer_get_type ())
  49 #define GTK_CELL_RENDERER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRenderer))
  50 #define GTK_CELL_RENDERER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CELL_RENDERER, GtkCellRendererClass))
  51 #define GTK_IS_CELL_RENDERER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CELL_RENDERER))
  52 #define GTK_IS_CELL_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CELL_RENDERER))
  53 #define GTK_CELL_RENDERER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRendererClass))
  54
  55 typedef struct _GtkCellRenderer              GtkCellRenderer;
  56 typedef struct _GtkCellRendererPrivate       GtkCellRendererPrivate;
  57 typedef struct _GtkCellRendererClass         GtkCellRendererClass;
  58
  59 struct _GtkCellRenderer
  60 {
  61   GInitiallyUnowned parent_instance;
  62
  63   /* <private> */
  64   GtkCellRendererPrivate *priv;
  65 };
  66
  67 struct _GtkCellRendererClass
  68 {
  69   GInitiallyUnownedClass parent_class;
  70
  71   /* vtable - not signals */
  72   GtkSizeRequestMode (* get_request_mode)                (GtkCellRenderer      *cell);
  73   void               (* get_preferred_width)             (GtkCellRenderer      *cell,
  74                                                           GtkWidget            *widget,
  75                                                           gint                 *minimum_size,
  76                                                           gint                 *natural_size);
  77   void               (* get_preferred_height_for_width)  (GtkCellRenderer      *cell,
  78                                                           GtkWidget            *widget,
  79                                                           gint                  width,
  80                                                           gint                 *minimum_height,
  81                                                           gint                 *natural_height);
  82   void               (* get_preferred_height)            (GtkCellRenderer      *cell,
  83                                                           GtkWidget            *widget,
  84                                                           gint                 *minimum_size,
  85                                                           gint                 *natural_size);
  86   void               (* get_preferred_width_for_height)  (GtkCellRenderer      *cell,
  87                                                           GtkWidget            *widget,
  88                                                           gint                  height,
  89                                                           gint                 *minimum_width,
  90                                                           gint                 *natural_width);
  91   void               (* get_size)                        (GtkCellRenderer      *cell,
  92                                                           GtkWidget            *widget,
  93                                                           const GdkRectangle   *cell_area,
  94                                                           gint                 *x_offset,
  95                                                           gint                 *y_offset,
  96                                                           gint                 *width,
  97                                                           gint                 *height);
  98   void               (* render)                          (GtkCellRenderer      *cell,
  99                                                           cairo_t              *cr,
 100                                                           GtkWidget            *widget,
 101                                                           const GdkRectangle   *background_area,
 102                                                           const GdkRectangle   *cell_area,
 103                                                           GtkCellRendererState  flags);
 104   gboolean           (* activate)                        (GtkCellRenderer      *cell,
 105                                                           GdkEvent             *event,
 106                                                           GtkWidget            *widget,
 107                                                           const gchar          *path,
 108                                                           const GdkRectangle   *background_area,
 109                                                           const GdkRectangle   *cell_area,
 110                                                           GtkCellRendererState  flags);
 111   GtkCellEditable *  (* start_editing)                   (GtkCellRenderer      *cell,
 112                                                           GdkEvent             *event,
 113                                                           GtkWidget            *widget,
 114                                                           const gchar          *path,
 115                                                           const GdkRectangle   *background_area,
 116                                                           const GdkRectangle   *cell_area,
 117                                                           GtkCellRendererState  flags);
 118
 119   /* Signals */
 120   void (* editing_canceled) (GtkCellRenderer *cell);
 121   void (* editing_started)  (GtkCellRenderer *cell,
 122                              GtkCellEditable *editable,
 123                              const gchar     *path);
 124
 125   /* Padding for future expansion */
 126   void (*_gtk_reserved1) (void);
 127   void (*_gtk_reserved2) (void);
 128 };
 129
 130 GType              gtk_cell_renderer_get_type       (void) G_GNUC_CONST;
 131
 132 GtkSizeRequestMode gtk_cell_renderer_get_request_mode               (GtkCellRenderer    *cell);
 133 void               gtk_cell_renderer_get_preferred_width            (GtkCellRenderer    *cell,
 134                                                                      GtkWidget          *widget,
 135                                                                      gint               *minimum_size,
 136                                                                      gint               *natural_size);
 137 void               gtk_cell_renderer_get_preferred_height_for_width (GtkCellRenderer    *cell,
 138                                                                      GtkWidget          *widget,
 139                                                                      gint                width,
 140                                                                      gint               *minimum_height,
 141                                                                      gint               *natural_height);
 142 void               gtk_cell_renderer_get_preferred_height           (GtkCellRenderer    *cell,
 143                                                                      GtkWidget          *widget,
 144                                                                      gint               *minimum_size,
 145                                                                      gint               *natural_size);
 146 void               gtk_cell_renderer_get_preferred_width_for_height (GtkCellRenderer    *cell,
 147                                                                      GtkWidget          *widget,
 148                                                                      gint                height,
 149                                                                      gint               *minimum_width,
 150                                                                      gint               *natural_width);
 151 void               gtk_cell_renderer_get_preferred_size             (GtkCellRenderer    *cell,
 152                                                                      GtkWidget          *widget,
 153                                                                      GtkRequisition     *minimum_size,
 154                                                                      GtkRequisition     *natural_size);
 155 #ifndef GTK_DISABLE_DEPRECATED
 156 void             gtk_cell_renderer_get_size       (GtkCellRenderer      *cell,
 157                                                    GtkWidget            *widget,
 158                                                    const GdkRectangle   *cell_area,
 159                                                    gint                 *x_offset,
 160                                                    gint                 *y_offset,
 161                                                    gint                 *width,
 162                                                    gint                 *height);
 163 #endif
 164 void             gtk_cell_renderer_render         (GtkCellRenderer      *cell,
 165                                                    cairo_t              *cr,
 166                                                    GtkWidget            *widget,
 167                                                    const GdkRectangle   *background_area,
 168                                                    const GdkRectangle   *cell_area,
 169                                                    GtkCellRendererState  flags);
 170 gboolean         gtk_cell_renderer_activate       (GtkCellRenderer      *cell,
 171                                                    GdkEvent             *event,
 172                                                    GtkWidget            *widget,
 173                                                    const gchar          *path,
 174                                                    const GdkRectangle   *background_area,
 175                                                    const GdkRectangle   *cell_area,
 176                                                    GtkCellRendererState  flags);
 177 GtkCellEditable *gtk_cell_renderer_start_editing  (GtkCellRenderer      *cell,
 178                                                    GdkEvent             *event,
 179                                                    GtkWidget            *widget,
 180                                                    const gchar          *path,
 181                                                    const GdkRectangle   *background_area,
 182                                                    const GdkRectangle   *cell_area,
 183                                                    GtkCellRendererState  flags);
 184
 185 void             gtk_cell_renderer_set_fixed_size (GtkCellRenderer      *cell,
 186                                                    gint                  width,
 187                                                    gint                  height);
 188 void             gtk_cell_renderer_get_fixed_size (GtkCellRenderer      *cell,
 189                                                    gint                 *width,
 190                                                    gint                 *height);
 191
 192 void             gtk_cell_renderer_set_alignment  (GtkCellRenderer      *cell,
 193                                                    gfloat                xalign,
 194                                                    gfloat                yalign);
 195 void             gtk_cell_renderer_get_alignment  (GtkCellRenderer      *cell,
 196                                                    gfloat               *xalign,
 197                                                    gfloat               *yalign);
 198
 199 void             gtk_cell_renderer_set_padding    (GtkCellRenderer      *cell,
 200                                                    gint                  xpad,
 201                                                    gint                  ypad);
 202 void             gtk_cell_renderer_get_padding    (GtkCellRenderer      *cell,
 203                                                    gint                 *xpad,
 204                                                    gint                 *ypad);
 205
 206 void             gtk_cell_renderer_set_visible    (GtkCellRenderer      *cell,
 207                                                    gboolean              visible);
 208 gboolean         gtk_cell_renderer_get_visible    (GtkCellRenderer      *cell);
 209
 210 void             gtk_cell_renderer_set_sensitive  (GtkCellRenderer      *cell,
 211                                                    gboolean              sensitive);
 212 gboolean         gtk_cell_renderer_get_sensitive  (GtkCellRenderer      *cell);
 213
 214 /* For use by cell renderer implementations only */
 215 void             gtk_cell_renderer_stop_editing   (GtkCellRenderer      *cell,
 216                                                    gboolean              canceled);
 217
 218
 219 void            _gtk_cell_renderer_calc_offset    (GtkCellRenderer      *cell,
 220                                                    const GdkRectangle   *cell_area,
 221                                                    GtkTextDirection      direction,
 222                                                    gint                  width,
 223                                                    gint                  height,
 224                                                    gint                 *x_offset,
 225                                                    gint                 *y_offset);
 226
 227 G_END_DECLS
 228
 229 #endif /* __GTK_CELL_RENDERER_H__ */