// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _LIBGDAMM_QUERYFIELDFUNC_H
#define _LIBGDAMM_QUERYFIELDFUNC_H


#include <glibmm.h>

// -*- C++ -*- // this is for the .hg, I realize gensig puts one in

/* queryfieldfunc.h
 *
 * Copyright 2003 libgdamm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <glibmm/object.h>
#include <libgdamm/dict.h>
#include <libgdamm/dictfunction.h>
#include <libgdamm/datamodel.h>

#include <libgdamm/xmlstorage.h>
#include <libgdamm/queryfield.h>
#include <libgdamm/query.h>
#include <libgdamm/referer.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GdaQueryFieldFunc GdaQueryFieldFunc;
typedef struct _GdaQueryFieldFuncClass GdaQueryFieldFuncClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Gnome
{

namespace Gda
{ class QueryFieldFunc_Class; } // namespace Gda

} // namespace Gnome
namespace Gnome
{

namespace Gda
{

/** Represents a function (selected by a GdaDictFunction object)
 * 
 * @ingroup Queries
 */

class QueryFieldFunc
 : public QueryField,
   public XmlStorage,
   public Referer,
   public EntityField,
   public Renderer
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:
  typedef QueryFieldFunc CppObjectType;
  typedef QueryFieldFunc_Class CppClassType;
  typedef GdaQueryFieldFunc BaseObjectType;
  typedef GdaQueryFieldFuncClass BaseClassType;

private:  friend class QueryFieldFunc_Class;
  static CppClassType queryfieldfunc_class_;

private:
  // noncopyable
  QueryFieldFunc(const QueryFieldFunc&);
  QueryFieldFunc& operator=(const QueryFieldFunc&);

protected:
  explicit QueryFieldFunc(const Glib::ConstructParams& construct_params);
  explicit QueryFieldFunc(GdaQueryFieldFunc* castitem);

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

public:
  virtual ~QueryFieldFunc();

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;
  static GType get_base_type() G_GNUC_CONST;
#endif

  ///Provides access to the underlying C GObject.
  GdaQueryFieldFunc*       gobj()       { return reinterpret_cast<GdaQueryFieldFunc*>(gobject_); }

  ///Provides access to the underlying C GObject.
  const GdaQueryFieldFunc* gobj() const { return reinterpret_cast<GdaQueryFieldFunc*>(gobject_); }

  ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
  GdaQueryFieldFunc* gobj_copy();

private:

  
public:
  explicit QueryFieldFunc(const Glib::RefPtr<Query>& query, const Glib::ustring& func_name);
  
  
  /** Get the name of the function which @a func represents
   * @return The function name.
   */
  Glib::RefPtr<DictFunction> get_ref_func();
  
  Glib::ustring get_ref_func_name();
  
  
  /** Sets the argument(s) of @a func. If @a args is <tt>0</tt>, then
   * all the arguments (if there was any) are removed.
   * 
   * If @a func is not active, then no check on the provided args
   * is performed.
   * @param args A list of Gda::QueryField objects.
   * @return <tt>true</tt> if no error occurred.
   */
  bool set_args(const Glib::SListHandle< Glib::RefPtr<QueryField> >& args);
  
  /** Get a list of the other Gda::QueryField objects which are arguments of @a func. If some
   * of them are missing, then a <tt>0</tt> is inserted where it should have been.
   * @return A new list of arguments.
   */
  Glib::SListHandle< Glib::RefPtr<QueryField> > get_args();


public:

public:
  //C++ methods used to invoke GTK+ virtual functions:
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED

protected:
  //GTK+ Virtual Functions (override these to change behaviour):
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED

  //Default Signal Handlers::
#ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED


};

} // namespace Gda
} // namespace Gnome


namespace Glib
{
  /** A Glib::wrap() method for this object.
   * 
   * @param object The C instance.
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
   * @result A C++ instance that wraps this C instance.
   *
   * @relates Gnome::Gda::QueryFieldFunc
   */
  Glib::RefPtr<Gnome::Gda::QueryFieldFunc> wrap(GdaQueryFieldFunc* object, bool take_copy = false);
}


#endif /* _LIBGDAMM_QUERYFIELDFUNC_H */

