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_DISABLE_SINGLE_INCLUDES) && !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/gtkobject.h>
  28 #include <gtk/gtkwidget.h>
  29 #include <gtk/gtkcelleditable.h>
  30
  31 G_BEGIN_DECLS
  32
  33 typedef enum
  34 {
  35   GTK_CELL_RENDERER_SELECTED    = 1 << 0,
  36   GTK_CELL_RENDERER_PRELIT      = 1 << 1,
  37   GTK_CELL_RENDERER_INSENSITIVE = 1 << 2,
  38   /* this flag means the cell is in the sort column/row */
  39   GTK_CELL_RENDERER_SORTED      = 1 << 3,
  40   GTK_CELL_RENDERER_FOCUSED     = 1 << 4
  41 } GtkCellRendererState;
  42
  43 typedef enum
  44 {
  45   GTK_CELL_RENDERER_MODE_INERT,
  46   GTK_CELL_RENDERER_MODE_ACTIVATABLE,
  47   GTK_CELL_RENDERER_MODE_EDITABLE
  48 } GtkCellRendererMode;
  49
  50 #define GTK_TYPE_CELL_RENDERER            (gtk_cell_renderer_get_type ())
  51 #define GTK_CELL_RENDERER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRenderer))
  52 #define GTK_CELL_RENDERER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_CELL_RENDERER, GtkCellRendererClass))
  53 #define GTK_IS_CELL_RENDERER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_CELL_RENDERER))
  54 #define GTK_IS_CELL_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CELL_RENDERER))
  55 #define GTK_CELL_RENDERER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRendererClass))
  56
  57 typedef struct _GtkCellRenderer GtkCellRenderer;
  58 typedef struct _GtkCellRendererClass GtkCellRendererClass;
  59
  60 struct _GtkCellRenderer
  61 {
  62   GtkObject parent;
  63
  64   gfloat GSEAL (xalign);
  65   gfloat GSEAL (yalign);
  66
  67   gint GSEAL (width);
  68   gint GSEAL (height);
  69
  70   guint16 GSEAL (xpad);
  71   guint16 GSEAL (ypad);
  72
  73   guint GSEAL (mode) : 2;
  74   guint GSEAL (visible) : 1;
  75   guint GSEAL (is_expander) : 1;
  76   guint GSEAL (is_expanded) : 1;
  77   guint GSEAL (cell_background_set) : 1;
  78   guint GSEAL (sensitive) : 1;
  79   guint GSEAL (editing) : 1;
  80 };
  81
  82 struct _GtkCellRendererClass
  83 {
  84   GtkObjectClass parent_class;
  85
  86   /* vtable - not signals */
  87   void             (* get_size)      (GtkCellRenderer      *cell,
  88                                       GtkWidget            *widget,
  89                                       GdkRectangle         *cell_area,
  90                                       gint                 *x_offset,
  91                                       gint                 *y_offset,
  92                                       gint                 *width,
  93                                       gint                 *height);
  94   void             (* render)        (GtkCellRenderer      *cell,
  95                                       GdkDrawable          *window,
  96                                       GtkWidget            *widget,
  97                                       GdkRectangle         *background_area,
  98                                       GdkRectangle         *cell_area,
  99                                       GdkRectangle         *expose_area,
 100                                       GtkCellRendererState  flags);
 101   gboolean         (* activate)      (GtkCellRenderer      *cell,
 102                                       GdkEvent             *event,
 103                                       GtkWidget            *widget,
 104                                       const gchar          *path,
 105                                       GdkRectangle         *background_area,
 106                                       GdkRectangle         *cell_area,
 107                                       GtkCellRendererState  flags);
 108   GtkCellEditable *(* start_editing) (GtkCellRenderer      *cell,
 109                                       GdkEvent             *event,
 110                                       GtkWidget            *widget,
 111                                       const gchar          *path,
 112                                       GdkRectangle         *background_area,
 113                                       GdkRectangle         *cell_area,
 114                                       GtkCellRendererState  flags);
 115
 116   /* Signals */
 117   void (* editing_canceled) (GtkCellRenderer *cell);
 118   void (* editing_started)  (GtkCellRenderer *cell,
 119                              GtkCellEditable *editable,
 120                              const gchar     *path);
 121
 122   /* Padding for future expansion */
 123   void (*_gtk_reserved1) (void);
 124   void (*_gtk_reserved2) (void);
 125 };
 126
 127 GType            gtk_cell_renderer_get_type       (void) G_GNUC_CONST;
 128
 129 void             gtk_cell_renderer_get_size       (GtkCellRenderer      *cell,
 130                                                    GtkWidget            *widget,
 131                                                    const GdkRectangle   *cell_area,
 132                                                    gint                 *x_offset,
 133                                                    gint                 *y_offset,
 134                                                    gint                 *width,
 135                                                    gint                 *height);
 136 void             gtk_cell_renderer_render         (GtkCellRenderer      *cell,
 137                                                    GdkWindow            *window,
 138                                                    GtkWidget            *widget,
 139                                                    const GdkRectangle   *background_area,
 140                                                    const GdkRectangle   *cell_area,
 141                                                    const GdkRectangle   *expose_area,
 142                                                    GtkCellRendererState  flags);
 143 gboolean         gtk_cell_renderer_activate       (GtkCellRenderer      *cell,
 144                                                    GdkEvent             *event,
 145                                                    GtkWidget            *widget,
 146                                                    const gchar          *path,
 147                                                    const GdkRectangle   *background_area,
 148                                                    const GdkRectangle   *cell_area,
 149                                                    GtkCellRendererState  flags);
 150 GtkCellEditable *gtk_cell_renderer_start_editing  (GtkCellRenderer      *cell,
 151                                                    GdkEvent             *event,
 152                                                    GtkWidget            *widget,
 153                                                    const gchar          *path,
 154                                                    const GdkRectangle   *background_area,
 155                                                    const GdkRectangle   *cell_area,
 156                                                    GtkCellRendererState  flags);
 157 void             gtk_cell_renderer_set_fixed_size (GtkCellRenderer      *cell,
 158                                                    gint                  width,
 159                                                    gint                  height);
 160 void             gtk_cell_renderer_get_fixed_size (GtkCellRenderer      *cell,
 161                                                    gint                 *width,
 162                                                    gint                 *height);
 163
 164 /* For use by cell renderer implementations only */
 165 #ifndef GTK_DISABLE_DEPRECATED
 166 void gtk_cell_renderer_editing_canceled (GtkCellRenderer *cell);
 167 #endif
 168 void gtk_cell_renderer_stop_editing     (GtkCellRenderer *cell,
 169                                          gboolean         canceled);
 170
 171
 172 G_END_DECLS
 173
 174 #endif /* __GTK_CELL_RENDERER_H__ */