ardour/libs/gtkmm2/gtk/src/object.hg
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

114 lines
4 KiB
Text

/* $Id: object.hg,v 1.5 2006/04/07 14:11:37 gustin Exp $ */
/* 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>
_DEFS(gtkmm,gtk)
_PINCLUDE(glibmm/private/object_p.h)
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
{
_CLASS_GTKOBJECT(Object,GtkObject,GTK_OBJECT,Glib::Object,GObject)
_IGNORE(gtk_object_ref, gtk_object_unref, gtk_object_weakref, gtk_object_weakunref, gtk_object_set_data,
gtk_object_set_data_full, gtk_object_remove_data, gtk_object_get_data, gtk_object_remove_no_notify,
gtk_object_set_user_data, gtk_object_get_user_data, gtk_object_set_data_by_id, gtk_object_set_data_by_id_full,
gtk_object_get_data_by_id, gtk_object_remove_data_by_id, gtk_object_remove_no_notify_by_id, gtk_object_get,
gtk_object_set, gtk_object_add_arg_type, gtk_object_destroy, gtk_object_sink)
_CUSTOM_DTOR
_CUSTOM_CTOR_CAST
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
_WRAP_PROPERTY("user-data", void*)
#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")
_IGNORE_SIGNAL(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