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 88 89 90 91 92 93 94 95 96 97 98
|
/* mg-parameter.h
*
* Copyright (C) 2003 Vivien Malerba
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
#ifndef __MG_PARAMETER_H_
#define __MG_PARAMETER_H_
#include "mg-defs.h"
#include "mg-base.h"
#include <libgda/libgda.h>
G_BEGIN_DECLS
#define MG_PARAMETER_TYPE (mg_parameter_get_type())
#define MG_PARAMETER(obj) G_TYPE_CHECK_INSTANCE_CAST (obj, mg_parameter_get_type(), MgParameter)
#define MG_PARAMETER_CLASS(klass) G_TYPE_CHECK_CLASS_CAST (klass, mg_parameter_get_type (), MgParameterClass)
#define IS_MG_PARAMETER(obj) G_TYPE_CHECK_INSTANCE_TYPE (obj, mg_parameter_get_type ())
/* error reporting */
extern GQuark mg_parameter_error_quark (void);
#define MG_PARAMETER_ERROR mg_parameter_error_quark ()
enum {
MG_PARAMETER_QUERY_LIMIT_ERROR
};
/* struct for the object's data */
struct _MgParameter
{
MgBase object;
MgParameterPrivate *priv;
};
/* struct for the object's class */
struct _MgParameterClass
{
MgBaseClass class;
};
guint mg_parameter_get_type (void);
GObject *mg_parameter_new (MgConf *conf, MgServerDataType *type);
GObject *mg_parameter_new_copy (MgParameter *orig);
GObject *mg_parameter_new_with_dest_field (MgQfield *field, MgServerDataType *type);
void mg_parameter_add_dest_field (MgParameter *param, MgQfield *field);
GSList *mg_parameter_get_dest_fields (MgParameter *param);
MgServerDataType *mg_parameter_get_data_type (MgParameter *param);
const GdaValue *mg_parameter_get_value (MgParameter *param);
void mg_parameter_set_value (MgParameter *param, const GdaValue *value);
void mg_parameter_declare_invalid (MgParameter *param);
gboolean mg_parameter_is_valid (MgParameter *param);
const GdaValue *mg_parameter_get_default_value (MgParameter *param);
void mg_parameter_set_default_value (MgParameter *param, const GdaValue *value);
void mg_parameter_set_not_null (MgParameter *param, gboolean not_null);
gboolean mg_parameter_get_not_null (MgParameter *param);
gboolean mg_parameter_set_source_field (MgParameter *param, MgQfield *field, GError **error);
MgQfield *mg_parameter_get_source_field (MgParameter *param);
void mg_parameter_add_dependency (MgParameter *param, MgParameter *depend_on);
void mg_parameter_del_dependency (MgParameter *param, MgParameter *depend_on);
GSList *mg_parameter_get_dependencies (MgParameter *param);
void mg_parameter_replace_ref (MgParameter *param, GHashTable *replacements);
void mg_parameter_bind_to_param (MgParameter *param, MgParameter *bind_to);
MgParameter *mg_parameter_get_bind_param (MgParameter *param);
gboolean mg_parameter_requires_user_input (MgParameter *param);
void mg_parameter_set_user_input_required (MgParameter *param, gboolean input_required);
G_END_DECLS
#endif
|