search-core-type.h

/*
 *  Copyright (C) 2002 Derek Atkins
 *
 *  Authors: Derek Atkins <warlord@MIT.EDU>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * 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., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef _GNCSEARCH_CORE_TYPE_H
#define _GNCSEARCH_CORE_TYPE_H

#include "qof.h"
#include "search-param.h"

#define GNC_TYPE_SEARCH_CORE_TYPE               (gnc_search_core_type_get_type ())
#define GNC_SEARCH_CORE_TYPE(o)                 (G_TYPE_CHECK_INSTANCE_CAST ((o), GNC_TYPE_SEARCH_CORE_TYPE, GNCSearchCoreType))
#define GNC_SEARCH_CORE_TYPE_CLASS(k)           (G_TYPE_CHECK_CLASS_CAST ((k), GNC_TYPE_SEARCH_CORE_TYPE, GNCSearchCoreTypeClass))
#define GNC_IS_SEARCH_CORE_TYPE(o)              (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNC_TYPE_SEARCH_CORE_TYPE))
#define GNC_SEARCH_CORE_TYPE_GET_CLASS(o)       (G_TYPE_INSTANCE_GET_CLASS ((o), GNC_TYPE_SEARCH_CORE_TYPE, GNCSearchCoreTypeClass))

typedef struct
{
    GtkObject parent;

    GNCSearchParam *    param;
} GNCSearchCoreType;

typedef struct
{
    GObjectClass parent_class;

    /* virtual methods */
    void                        (*grab_focus) (GNCSearchCoreType *fe);
    void                        (*editable_enters) (GNCSearchCoreType *fe);
    gboolean            (*validate) (GNCSearchCoreType *fe);
    GNCSearchCoreType * (*clone) (GNCSearchCoreType *fe);
    GtkWidget *         (*get_widget) (GNCSearchCoreType *);
    QofQueryPredData*   (*get_predicate) (GNCSearchCoreType *);

    /* signals */
} GNCSearchCoreTypeClass;

/* These are internal functions */
GType                   gnc_search_core_type_get_type (void);
GNCSearchCoreType *     gnc_search_core_type_new (void);

/* Create a new search core_type */
GNCSearchCoreType *     gnc_search_core_type_new_type_name (const char *type);

/* methods */
void                    gnc_search_core_type_grab_focus (GNCSearchCoreType *fe);
void                    gnc_search_core_type_editable_enters (GNCSearchCoreType *fe);
gboolean                gnc_search_core_type_validate (GNCSearchCoreType *fe);
GNCSearchCoreType *     gnc_search_core_type_clone (GNCSearchCoreType *fe);
GtkWidget *             gnc_search_core_type_get_widget (GNCSearchCoreType *fe);
QofQueryPredData*               gnc_search_core_type_get_predicate (GNCSearchCoreType *fe);

/* Register a new type in the Core Type Database */
typedef GNCSearchCoreType * (*GNCSearchCoreNew) (void);
void gnc_search_core_register_type (const char *type_name,
                                    GNCSearchCoreNew fcn);


/* Initialize and Finalize the Core Type Database */
void gnc_search_core_initialize (void);
void gnc_search_core_finalize (void);


#endif /* ! _GNCSEARCH_CORE_TYPE_H */