aboutsummaryrefslogtreecommitdiffstats
path: root/filter/filter-element.h
blob: d5ff5177ce14a59412a5c6676a585d7e98b797d4 (plain) (blame)
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
/*
 *  Copyright (C) 2000 Ximian Inc.
 *
 *  Authors: Not Zed <notzed@lostzed.mmc.com.au>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef _FILTER_ELEMENT_H
#define _FILTER_ELEMENT_H

#include <gtk/gtkobject.h>
#include <gtk/gtkwidget.h>
#include <gnome-xml/parser.h>
#include <gnome-xml/xmlmemory.h>

#define FILTER_ELEMENT(obj) GTK_CHECK_CAST (obj, filter_element_get_type (), FilterElement)
#define FILTER_ELEMENT_CLASS(klass) GTK_CHECK_CLASS_CAST (klass, filter_element_get_type (), FilterElementClass)
#define IS_FILTER_ELEMENT(obj)      GTK_CHECK_TYPE (obj, filter_element_get_type ())

typedef struct _FilterElement   FilterElement;
typedef struct _FilterElementClass  FilterElementClass;

struct _FilterElement {
    GtkObject parent;
    struct _FilterElementPrivate *priv;

    char *name;
    gpointer data;
};

struct _FilterPart;

struct _FilterElementClass {
    GtkObjectClass parent_class;

    /* virtual methods */
    gboolean (*validate)(FilterElement *fe);
    
    void (*xml_create)(FilterElement *, xmlNodePtr);
    xmlNodePtr (*xml_encode)(FilterElement *);
    int (*xml_decode)(FilterElement *, xmlNodePtr);

    FilterElement *(*clone)(FilterElement *fe);

    GtkWidget *(*get_widget)(FilterElement *);
    void (*build_code)(FilterElement *, GString *, struct _FilterPart *ff);
    void (*format_sexp)(FilterElement *, GString *);

    /* signals */
};

guint       filter_element_get_type (void);
FilterElement   *filter_element_new (void);

FilterElement   *filter_element_new_type_name   (const char *type);

void            filter_element_set_data (FilterElement *fe, gpointer data);

/* methods */
gboolean        filter_element_validate         (FilterElement *fe);

void        filter_element_xml_create   (FilterElement *fe, xmlNodePtr node);

xmlNodePtr  filter_element_xml_encode   (FilterElement *fe);
int     filter_element_xml_decode   (FilterElement *fe, xmlNodePtr node);
FilterElement   *filter_element_clone       (FilterElement *fe);
void        filter_element_copy_value   (FilterElement *de, FilterElement *se);

GtkWidget   *filter_element_get_widget  (FilterElement *fe);
void        filter_element_build_code   (FilterElement *fe, GString *out, struct _FilterPart *ff);
void        filter_element_format_sexp  (FilterElement *fe, GString *out);

#endif /* ! _FILTER_ELEMENT_H */