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   GtkObject parent;
  62
  63   /* <private> */
  64   GtkCellRendererPrivate *priv;
  65 };
  66
  67 struct _GtkCellRendererClass
  68 {
  69   GtkObjectClass parent_class;
  70
  71   /* vtable - not signals */
  72   void             (* get_size)      (GtkCellRenderer      *cell,
  73                                       GtkWidget            *widget,
  74                                       GdkRectangle         *cell_area,
  75                                       gint                 *x_offset,
  76                                       gint                 *y_offset,
  77                                       gint                 *width,
  78                                       gint                 *height);
  79   void             (* render)        (GtkCellRenderer      *cell,
  80                                       GdkDrawable          *window,
  81                                       GtkWidget            *widget,
  82                                       GdkRectangle         *background_area,
  83                                       GdkRectangle         *cell_area,
  84                                       GdkRectangle         *expose_area,
  85                                       GtkCellRendererState  flags);
  86   gboolean         (* activate)      (GtkCellRenderer      *cell,
  87                                       GdkEvent             *event,
  88                                       GtkWidget            *widget,
  89                                       const gchar          *path,
  90                                       GdkRectangle         *background_area,
  91                                       GdkRectangle         *cell_area,
  92                                       GtkCellRendererState  flags);
  93   GtkCellEditable *(* start_editing) (GtkCellRenderer      *cell,
  94                                       GdkEvent             *event,
  95                                       GtkWidget            *widget,
  96                                       const gchar          *path,
  97                                       GdkRectangle         *background_area,
  98                                       GdkRectangle         *cell_area,
  99                                       GtkCellRendererState  flags);
 100
 101   /* Signals */
 102   void (* editing_canceled) (GtkCellRenderer *cell);
 103   void (* editing_started)  (GtkCellRenderer *cell,
 104                              GtkCellEditable *editable,
 105                              const gchar     *path);
 106
 107   /* Padding for future expansion */
 108   void (*_gtk_reserved1) (void);
 109   void (*_gtk_reserved2) (void);
 110 };
 111
 112 GType            gtk_cell_renderer_get_type       (void) G_GNUC_CONST;
 113
 114 void             gtk_cell_renderer_get_size       (GtkCellRenderer      *cell,
 115                                                    GtkWidget            *widget,
 116                                                    const GdkRectangle   *cell_area,
 117                                                    gint                 *x_offset,
 118                                                    gint                 *y_offset,
 119                                                    gint                 *width,
 120                                                    gint                 *height);
 121 void             gtk_cell_renderer_render         (GtkCellRenderer      *cell,
 122                                                    GdkWindow            *window,
 123                                                    GtkWidget            *widget,
 124                                                    const GdkRectangle   *background_area,
 125                                                    const GdkRectangle   *cell_area,
 126                                                    const GdkRectangle   *expose_area,
 127                                                    GtkCellRendererState  flags);
 128 gboolean         gtk_cell_renderer_activate       (GtkCellRenderer      *cell,
 129                                                    GdkEvent             *event,
 130                                                    GtkWidget            *widget,
 131                                                    const gchar          *path,
 132                                                    const GdkRectangle   *background_area,
 133                                                    const GdkRectangle   *cell_area,
 134                                                    GtkCellRendererState  flags);
 135 GtkCellEditable *gtk_cell_renderer_start_editing  (GtkCellRenderer      *cell,
 136                                                    GdkEvent             *event,
 137                                                    GtkWidget            *widget,
 138                                                    const gchar          *path,
 139                                                    const GdkRectangle   *background_area,
 140                                                    const GdkRectangle   *cell_area,
 141                                                    GtkCellRendererState  flags);
 142
 143 void             gtk_cell_renderer_set_fixed_size (GtkCellRenderer      *cell,
 144                                                    gint                  width,
 145                                                    gint                  height);
 146 void             gtk_cell_renderer_get_fixed_size (GtkCellRenderer      *cell,
 147                                                    gint                 *width,
 148                                                    gint                 *height);
 149
 150 void             gtk_cell_renderer_set_alignment  (GtkCellRenderer      *cell,
 151                                                    gfloat                xalign,
 152                                                    gfloat                yalign);
 153 void             gtk_cell_renderer_get_alignment  (GtkCellRenderer      *cell,
 154                                                    gfloat               *xalign,
 155                                                    gfloat               *yalign);
 156
 157 void             gtk_cell_renderer_set_padding    (GtkCellRenderer      *cell,
 158                                                    gint                  xpad,
 159                                                    gint                  ypad);
 160 void             gtk_cell_renderer_get_padding    (GtkCellRenderer      *cell,
 161                                                    gint                 *xpad,
 162                                                    gint                 *ypad);
 163
 164 void             gtk_cell_renderer_set_visible    (GtkCellRenderer      *cell,
 165                                                    gboolean              visible);
 166 gboolean         gtk_cell_renderer_get_visible    (GtkCellRenderer      *cell);
 167
 168 void             gtk_cell_renderer_set_sensitive  (GtkCellRenderer      *cell,
 169                                                    gboolean              sensitive);
 170 gboolean         gtk_cell_renderer_get_sensitive  (GtkCellRenderer      *cell);
 171
 172 /* For use by cell renderer implementations only */
 173 void             gtk_cell_renderer_stop_editing   (GtkCellRenderer      *cell,
 174                                                    gboolean              canceled);
 175
 176
 177 void            _gtk_cell_renderer_calc_offset    (GtkCellRenderer      *cell,
 178                                                    const GdkRectangle   *cell_area,
 179                                                    GtkTextDirection      direction,
 180                                                    gint                  width,
 181                                                    gint                  height,
 182                                                    gint                 *x_offset,
 183                                                    gint                 *y_offset);
 184
 185 G_END_DECLS
 186
 187 #endif /* __GTK_CELL_RENDERER_H__ */