13
0
livetrax/libs/gtkmm2/gtk/gtkmm/object.h
Paul Davis 449aab3c46 rollback to 3428, before the mysterious removal of libs/* at 3431/3432
git-svn-id: svn://localhost/ardour2/branches/3.0@3435 d708f5d6-7413-0410-9779-e7cbd77b26cf
2008-06-02 21:41:35 +00:00

217 lines
6.2 KiB
C++

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_OBJECT_H
#define _GTKMM_OBJECT_H
#include <glibmm.h>
/* $Id$ */
/* Copyright (C) 1998-2002 The gtkmm 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 <gtkmm/base.h>
#include <gtkmmconfig.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkObject GtkObject;
typedef struct _GtkObjectClass GtkObjectClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{ class Object_Class; } // namespace Gtk
namespace Gtk
{
class Object;
/** Mark a Gtk::Object as owned by its parent container widget, so you don't need to delete it manually.
* For instance,
* @code
* Gtk::Button* button = Gtk::manage( new Gtk::Button("Hello") );
* vbox.pack_start(*button); //vbox will delete button when vbox is deleted.
* @endcode
*
* @param obj A Gtk::Object, such as a gtkmm widget.
* @result The Gtk::Object passed as the @a obj parameter.
*/
template<class T>
T* manage(T* obj)
{
obj->set_manage();
return obj;
}
/** Gtk::Object is the base class for all widgets, and for a few non-widget objects such as
* Gtk::Adjustment. Gtk::Object predates Glib::Object; non-widgets that derive from Gtk::Object
* rather than Glib::Object do so for backward compatibility reasons.
*
* The most interesting difference between Gtk::Object and Glib::Object is the ability to use Gtk::manage() to delegate memory management to the container widget. Gtk::Objects can also be
* explicitly deleted at any time, instead of using only reference-counting, and container widgets
* can respond when their child objects are being deleted (for instance by removing the widget).
*/
class GTKMM_API Object : public Glib::Object
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef Object CppObjectType;
typedef Object_Class CppClassType;
typedef GtkObject BaseObjectType;
typedef GtkObjectClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
virtual ~Object();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
friend class Object_Class;
static CppClassType object_class_;
// noncopyable
Object(const Object&);
Object& operator=(const Object&);
protected:
explicit Object(const Glib::ConstructParams& construct_params);
explicit Object(GtkObject* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
#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 GtkObject.
GtkObject* gobj() { return reinterpret_cast<GtkObject*>(gobject_); }
///Provides access to the underlying C GtkObject.
const GtkObject* gobj() const { return reinterpret_cast<GtkObject*>(gobject_); }
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
private:
public:
//void shutdown(); //We probably don't need this.
//void finalize(); //We probably don't need this.
//void set_user_data(gpointer data);
//gpointer get_user_data();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Used by Gtk::manage(). You should not need to use this directly.
*/
virtual void set_manage();
#endif //DOXYGEN_SHOULD_SKIP_THIS
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Anonymous User Data Pointer.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy<void*> property_user_data() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Anonymous User Data Pointer.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
* the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly<void*> property_user_data() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Private API.
*/
bool is_managed_() const;
#endif //DOXYGEN_SHOULD_SKIP_THIS
protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Private API.
*/
void destroy_();
#endif //DOXYGEN_SHOULD_SKIP_THIS
// If you need it, give me an example. murrayc. -- Me too. daniel.
//_WRAP_SIGNAL(void destroy(), "destroy")
#ifndef DOXYGEN_SHOULD_SKIP_THIS
void _init_unmanage(bool is_toplevel = false);
virtual void destroy_notify_(); //override.
void disconnect_cpp_wrapper();
void _destroy_c_instance();
static void callback_destroy_(GObject* gobject, void* data); //only connected for a short time.
// set if flags used by derived classes.
bool referenced_; // = not managed.
bool gobject_disposed_;
#endif //DOXYGEN_SHOULD_SKIP_THIS
};
} // namespace Gtk
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 Gtk::Object
*/
Gtk::Object* wrap(GtkObject* object, bool take_copy = false);
} //namespace Glib
#endif /* _GTKMM_OBJECT_H */