plugins/class-gen/element-editor.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
   2 /*  element-editor.h
   3  *  Copyright (C) 2006 Armin Burgmeier
   4  *
   5  *  This program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2 of the License, or
   8  *  (at your option) any later version.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU Library General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __CLASSGEN_ELEMENT_EDITOR_H__
  21 #define __CLASSGEN_ELEMENT_EDITOR_H__
  22
  23 #include <gtk/gtk.h>
  24
  25 #include <glib-object.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define CG_TYPE_ELEMENT_EDITOR             (cg_element_editor_get_type ())
  30 #define CG_ELEMENT_EDITOR(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), CG_TYPE_ELEMENT_EDITOR, CgElementEditor))
  31 #define CG_ELEMENT_EDITOR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), CG_TYPE_ELEMENT_EDITOR, CgElementEditorClass))
  32 #define CG_IS_ELEMENT_EDITOR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CG_TYPE_ELEMENT_EDITOR))
  33 #define CG_IS_ELEMENT_EDITOR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), CG_TYPE_ELEMENT_EDITOR))
  34 #define CG_ELEMENT_EDITOR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), CG_TYPE_ELEMENT_EDITOR, CgElementEditorClass))
  35
  36 typedef struct _CgElementEditorClass CgElementEditorClass;
  37 typedef struct _CgElementEditor CgElementEditor;
  38
  39 typedef enum
  40 {
  41         CG_ELEMENT_EDITOR_COLUMN_LIST,
  42         CG_ELEMENT_EDITOR_COLUMN_FLAGS,
  43         CG_ELEMENT_EDITOR_COLUMN_STRING,
  44         CG_ELEMENT_EDITOR_COLUMN_ARGUMENTS
  45 } CgElementEditorColumnType;
  46
  47 typedef struct CgElementEditorFlags_
  48 {
  49         const gchar *name;
  50         const gchar *abbrevation;
  51 } CgElementEditorFlags;
  52
  53 struct _CgElementEditorClass
  54 {
  55         GObjectClass parent_class;
  56 };
  57
  58 struct _CgElementEditor
  59 {
  60         GObject parent_instance;
  61 };
  62
  63 GType cg_element_editor_get_type (void) G_GNUC_CONST;
  64
  65 CgElementEditor *cg_element_editor_new (GtkTreeView *view,
  66                                         GtkButton *add_button,
  67                                         GtkButton *remove_button,
  68                                         guint n_columns,
  69                                         ...);
  70
  71 typedef void(*CgElementEditorTransformFunc) (GHashTable *, gpointer);
  72
  73 /* The CgElementEditorTransformFunc may be used to modify the values
  74  * before they are stored in the value heap. It is also possible to
  75  * remove some or to create new ones. You should keep the key string
  76  * static because it is not freed when the hash table is destroyed, but
  77  * the data string may be dynamically allocated, it will be freed
  78  * eventually. */
  79 void cg_element_editor_set_values (CgElementEditor *editor,
  80                                    const gchar *name,
  81                                    GHashTable *values,
  82                                    CgElementEditorTransformFunc func,
  83                                    gpointer user_data,
  84                                    ...);
  85
  86 typedef gboolean(*CgElementEditorConditionFunc) (const gchar **, gpointer);
  87
  88 void cg_element_editor_set_value_count (CgElementEditor *editor,
  89                                         const gchar *name,
  90                                         GHashTable *values,
  91                                         CgElementEditorConditionFunc func,
  92                                         gpointer user_data);
  93
  94 G_END_DECLS
  95
  96 #endif /* __CLASSGEN_ELEMENT_EDITOR_H__ */