builder.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_BUILDER_H
#define _GTKMM_BUILDER_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: builder.hg,v 1.19 2006/05/10 20:59:27 murrayc Exp $ */
 
/* Copyright (C) 2007 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <gtkmm/widget.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkBuilder GtkBuilder;
typedef struct _GtkBuilderClass GtkBuilderClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class Builder_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
class BuilderError : public Glib::Error
{
public:
  enum Code
  {
    INVALID_TYPE_FUNCTION,
    UNHANDLED_TAG,
    MISSING_ATTRIBUTE,
    INVALID_ATTRIBUTE,
    INVALID_TAG,
    MISSING_PROPERTY_VALUE,
    INVALID_VALUE,
    VERSION_MISMATCH,
    DUPLICATE_ID
  };
 
  BuilderError(Code error_code, const Glib::ustring& error_message);
  explicit BuilderError(GError* gobject);
  Code code() const;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
 
  static void throw_func(GError* gobject);
 
  friend void wrap_init(); // uses throw_func()
 
  #endif //DOXYGEN_SHOULD_SKIP_THIS
};
 
} // namespace Gtk
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::BuilderError::Code> : public Glib::Value_Enum<Gtk::BuilderError::Code>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
class Builder : public Glib::Object
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef Builder CppObjectType;
  typedef Builder_Class CppClassType;
  typedef GtkBuilder BaseObjectType;
  typedef GtkBuilderClass BaseClassType;
 
private:  friend class Builder_Class;
  static CppClassType builder_class_;
 
private:
  // noncopyable
  Builder(const Builder&);
  Builder& operator=(const Builder&);
 
protected:
  explicit Builder(const Glib::ConstructParams& construct_params);
  explicit Builder(GtkBuilder* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~Builder();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkBuilder*       gobj()       { return reinterpret_cast<GtkBuilder*>(gobject_); }
 
  const GtkBuilder* gobj() const { return reinterpret_cast<GtkBuilder*>(gobject_); }
 
  GtkBuilder* gobj_copy();
 
private:
 
 
protected:
 Builder();
 
 
public:
  static Glib::RefPtr<Builder> create();
 
 
  static Glib::RefPtr<Builder> create_from_file(const std::string& filename);
 
  static Glib::RefPtr<Builder> create_from_file(const std::string& filename, const Glib::ustring& object_id);
  //This is just to avoid the ambiguous call when using a string literal, 
  //caused by the overload that takes a StringArrayHandle.
  static Glib::RefPtr<Builder> create_from_file(const std::string& filename, const char* object_id);
  static Glib::RefPtr<Builder> create_from_file(const std::string& filename, const Glib::StringArrayHandle& object_ids);
 
  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer);
  //This is just to avoid the ambiguous call when using a string literal, 
  //caused by the overload that takes a StringArrayHandle.
  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const char* object_id);
 
  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const Glib::ustring& object_id);
 
  static Glib::RefPtr<Builder> create_from_string(const Glib::ustring& buffer, const Glib::StringArrayHandle& object_ids);
  
 
  bool add_from_file(const std::string& filename);
 
  //This is just to avoid the ambiguous call when using a string literal, 
  //caused by the overload that takes a StringArrayHandle.
  bool add_from_file(const std::string& filename, const char* object_id);
 
  bool add_from_file(const std::string& filename, const Glib::ustring& object_id);
 
 
  bool add_from_file(const std::string& filename, const Glib::StringArrayHandle& object_ids);
 
  //This is just to avoid the ambiguous call when using a string literal, 
  //caused by the overload that takes a StringArrayHandle.
  bool add_from_string(const Glib::ustring& buffer);
 
  bool add_from_string(const Glib::ustring& buffer, const char* object_id);
 
  bool add_from_string(const Glib::ustring& buffer, const Glib::ustring& object_id);
 
  bool add_from_string(const Glib::ustring& buffer, const Glib::StringArrayHandle& object_ids);
  
 
  bool add_from_string(const char* buffer, gsize length);
 
  //TODO: Custom-implement this and prevent it from being used with GTK_WIDGET-derived types?
  
  Glib::RefPtr<Glib::Object> get_object(const Glib::ustring& name);
 
  template <class T_Widget> inline
  void get_widget(const Glib::ustring& name, T_Widget*& widget)
  {
    // Initialize output parameter:
    widget = 0;
 
    // The dynamic_cast<> should never fail if get_widget_checked() succeeded.
    widget = dynamic_cast<T_Widget*>(this->get_widget_checked(name, T_Widget::get_base_type()));
 
    if(!widget)
      g_critical("Gtk::Builder::get_widget(): dynamic_cast<> failed.");
  }
 
  template <class T_Widget> inline
  void get_widget_derived(const Glib::ustring& name, T_Widget*& widget)
  {
     // Initialize output parameter:
     widget = 0;
     
     // Get the widget from the GtkBuilder file.
     typedef typename T_Widget::BaseObjectType cwidget_type;
     cwidget_type* pCWidget = (cwidget_type*)get_cwidget(name);
 
     //The error was already reported by get_cwidget().
     if(!pCWidget)
       return;
 
     //Check whether there is already a C++ wrapper instance associated with this C instance:
     Glib::ObjectBase* pObjectBase = ObjectBase::_get_current_wrapper((GObject*)pCWidget);
 
     //If there is already a C++ instance, then return it again:
     if(pObjectBase)
     {
       widget = dynamic_cast<T_Widget*>( Glib::wrap((GtkWidget*)pCWidget) );
       //Newer, more spec-complaint, versions of g++ cannot resolve a specific wrap() function in a template.
 
       //The dynamic cast checks that it is of the correct type.
       //Somebody might be trying to call get_widget_derived() after already calling get_widget(),
       //or after already calling get_widget_derived() with a different derived C++ type.
       if(!widget)
        g_critical("Gtk::Builder::get_widget_derived(): dynamic_cast<> failed. An existing C++ instance, of a different type, seems to exist.");      
     }
     else
     {
       //Create a new C++ instance to wrap the existing C instance:
       
       //Set the output variable. We needed to do this because we can not template the return type.
       Glib::RefPtr<Gtk::Builder> refThis(this);
       refThis->reference(); //take a copy.
       widget = new T_Widget(pCWidget, refThis);
       widget->reference(); //Because gtk_builder_get_object() does not give us a reference.
     }
  }
 
 
  //TODO:_WRAP_METHOD(GSList* get_objects(), gtk_builder_get_objects)
  //_WRAP_METHOD(void connect_signals(gpointer       user_data), gtk_builder_connect_signals)
  //_WRAP_METHOD(void connect_signals_full(GtkBuilderConnectFunc func, gpointer       user_data), gtk_builder_connect_signals_full)
  
  void set_translation_domain(const Glib::ustring& domain);
  
  Glib::ustring get_translation_domain() const;
  
  //We ignore gtk_builder_get_type_from_name() because it only seems useful when implementing GtkBuildable for widgets.
  
  
  Glib::PropertyProxy< Glib::ustring > property_translation_domain() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_translation_domain() const;
 
 
protected:
  Gtk::Widget* get_widget_checked(const Glib::ustring& name, GType type);
  GtkWidget* get_cwidget(const Glib::ustring& name);
 
 
  // TODO: Make sure this is actually invoked even with disabled vfuncs so
  // that GtkBuilder creates gtkmm's GObjects.
 
 
public:
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::Builder> wrap(GtkBuilder* object, bool take_copy = false);
}
 
 
#endif /* _GTKMM_BUILDER_H */