wxPython/src/_obj.i

/////////////////////////////////////////////////////////////////////////////
// Name:        _wxobj.i
// Purpose:     SWIG interface for wxObject
//
// Author:      Robin Dunn
//
// Created:     9-Aug-2003
// RCS-ID:      $Id$
// Copyright:   (c) 2003 by Total Control Software
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

// Not a %module


//---------------------------------------------------------------------------
%newgroup

DocStr(wxObject,
"The base class for most wx objects, although in wxPython not
much functionality is needed nor exposed.", "");

class wxObject {
public:

    %extend {
        DocStr(GetClassName,
               "Returns the class name of the C++ class using wxRTTI.", "");
        wxString GetClassName() {
            return self->GetClassInfo()->GetClassName();
        }

        %pythonPrepend Destroy "args[0].this.own(False)"
        DocStr(Destroy,
               "Deletes the C++ object this Python object is a proxy for.", "");
        void Destroy() {
            delete self;
        }
    }

    DocDeclStr(
        bool , IsSameAs(const wxObject& p) const,
        "For wx.Objects that use C++ reference counting internally, this method
can be used to determine if two objects are referencing the same data
object.", "");


    %property(ClassName, GetClassName, doc="See `GetClassName`");
};


//---------------------------------------------------------------------------
Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: _wxobj.i
	3	// Purpose: SWIG interface for wxObject
	4	//
	5	// Author: Robin Dunn
	6	//
	7	// Created: 9-Aug-2003
	8	// RCS-ID: $Id$
	9	// Copyright: (c) 2003 by Total Control Software
	10	// Licence: wxWindows license
	11	/////////////////////////////////////////////////////////////////////////////
	12
	13	// Not a %module
	14
	15
	16	//---------------------------------------------------------------------------
	17	%newgroup
	18
	19	DocStr(wxObject,
	20	"The base class for most wx objects, although in wxPython not
	21	much functionality is needed nor exposed.", "");
	22
	23	class wxObject {
	24	public:
	25
	26	%extend {
	27	DocStr(GetClassName,
	28	"Returns the class name of the C++ class using wxRTTI.", "");
	29	wxString GetClassName() {
	30	return self->GetClassInfo()->GetClassName();
	31	}
	32
	33	%pythonPrepend Destroy "args[0].this.own(False)"
	34	DocStr(Destroy,
	35	"Deletes the C++ object this Python object is a proxy for.", "");
	36	void Destroy() {
	37	delete self;
	38	}
	39	}
	40
	41	DocDeclStr(
	42	bool , IsSameAs(const wxObject& p) const,
	43	"For wx.Objects that use C++ reference counting internally, this method
	44	can be used to determine if two objects are referencing the same data
	45	object.", "");
	46
	47
	48	%property(ClassName, GetClassName, doc="See `GetClassName`");
	49	};
	50
	51
	52	//---------------------------------------------------------------------------