[wxWidgets.git] / wxPython / demo / OOR.py

# 11/13/2003 - Jeff Grimmett (grimmtooth@softhome.net)
#
# o Updated for wx namespace
#

import  wx
import  wx.html as wxhtml

#----------------------------------------------------------------------

BTN1 = wx.NewId()
BTN2 = wx.NewId()

class TestPanel(wx.Panel):
    def __init__(self, parent, log):
        wx.Panel.__init__(self, parent, -1)
        self.log = log

        sizer = wx.BoxSizer(wx.VERTICAL)
        html = wxhtml.HtmlWindow(self, -1)
        html.SetPage(overview)
        sizer.Add(html, 1, wx.EXPAND|wx.ALL, 5)

        btns = wx.BoxSizer(wx.HORIZONTAL)
        btns.Add((50, -1), 1, wx.EXPAND)
        btn1 = wx.Button(self, BTN1, "Find My Alter-ego") # don't save a ref to this one 
        btns.Add(btn1)
        btns.Add((50, -1), 1, wx.EXPAND)
        self.btn2 = wx.Button(self, BTN2, "Find Myself")
        btns.Add(self.btn2)
        btns.Add((50, -1), 1, wx.EXPAND)

        sizer.Add(btns, 0, wx.EXPAND|wx.ALL, 15)

        self.SetSizer(sizer)
        self.SetAutoLayout(True)

        self.sizer = sizer  # save it for testing later

        self.Bind(wx.EVT_BUTTON, self.OnFindButton1, id=BTN1)
        self.Bind(wx.EVT_BUTTON, self.OnFindButton2, id=BTN2)


    def OnFindButton1(self, evt):
        win = self.FindWindowById(BTN1)

        if win is None:
            self.log.write("***** OOPS! None returned...\n")
            return

        className = win.__class__.__name__

        if className in ["Button", "ButtonPtr"]:
            self.log.write("The types are the same! <grin>\n")
        else:
            self.log.write("Got %s, expected wxButton or wxButtonPtr\n" % className)


    def OnFindButton2(self, evt):
        win = self.FindWindowById(BTN2)

        if win is None:
            self.log.write("***** OOPS! None returned...\n")
            return

        if win is self.btn2:
            self.log.write("The objects are the same! <grin>\n")
        else:
            self.log.write("The objects are NOT the same! <frown>\n")

        win = evt.GetEventObject()

        if win is None:
            self.log.write("***** OOPS! None returned...\n")
            return

        if win is self.btn2:
            self.log.write("The objects are the same! <grin>\n")
        else:
            self.log.write("The objects are NOT the same! <frown>\n")

        sizer = self.GetSizer()

        if sizer is None:
            self.log.write("***** OOPS! None returned...\n")
            return

        if sizer is self.sizer:
            self.log.write("The objects are the same! <grin>\n")
        else:
            self.log.write("The objects are NOT the same! <frown>\n")


#----------------------------------------------------------------------

def runTest(frame, nb, log):
    win = TestPanel(nb, log)
    return win

#----------------------------------------------------------------------


overview = """\
<html><body>
<h2>Original Object Return</h2>

<p>Several methods in wxWindows return pointers to base class objects,
when in fact the actual object pointed to is of a derived type.  Since
SWIG isn't able to tell the actual type it just creates a new Python
shadow object of the base type to wrap around the base type pointer
and returns it.

<p>In wxPython prior to 2.3.0 this could cause annoying issues.  For
example if you called:

<pre>

        myText = someWindow.FindWindowById(txtID)
</pre>

expecting to get a wxTextCtrl you would actually get a wxWindow object
instead.  If you then try to call SetValue on that object you'll get
an exception since there is no such method.  This is the reason for
the wxPyTypeCast hack that has been in wxPython for so long.

<p>Even with wxPyTypeCast there was the issue that the object returned
was not the same one that was created in Python originally, but a new
object of the same type that wraps the same C++ pointer.  If the
programmer has set additional attributes of that original object they
will not exist in the new object.

<p>For a long time now I have wanted to do away with wxPyTypeCast and
also find a way to return the original Python object from methods like
FindWindowById.  This project naturally divides into two phases:

<p><ol>

<li>Teach the wrapper methods how to return objects of the right type,
and be able to then turn wxPyTypeCast in to a no-op.

<li>Be able to return the original Python shadow object if it still exists.

</ol>

<p>The first button below shows the first of these phases (<i>working</i>)
and the second will show #2 (<i>working as of Python 2.3.2</i>)

</body></html>
"""


if __name__ == '__main__':
    import sys,os
    import run
    run.main(['', os.path.basename(sys.argv[0])])
Commit	Line	Data
8fa876ca RD	1	# 11/13/2003 - Jeff Grimmett (grimmtooth@softhome.net)
	2	#
	3	# o Updated for wx namespace
	4	#
9416aa89	5
8fa876ca RD	6	import wx
8fa876ca RD	7	import wx.html as wxhtml
9416aa89 RD	8
	9	#----------------------------------------------------------------------
	10
8fa876ca RD	11	BTN1 = wx.NewId()
8fa876ca RD	12	BTN2 = wx.NewId()
9416aa89	13
8fa876ca	14	class TestPanel(wx.Panel):
9416aa89	15	def __init__(self, parent, log):
8fa876ca	16	wx.Panel.__init__(self, parent, -1)
9416aa89 RD	17	self.log = log
9416aa89 RD	18
8fa876ca RD	19	sizer = wx.BoxSizer(wx.VERTICAL)
8fa876ca RD	20	html = wxhtml.HtmlWindow(self, -1)
9416aa89	21	html.SetPage(overview)
8fa876ca	22	sizer.Add(html, 1, wx.EXPAND\|wx.ALL, 5)
9416aa89	23
8fa876ca RD	24	btns = wx.BoxSizer(wx.HORIZONTAL)
	25	btns.Add((50, -1), 1, wx.EXPAND)
	26	btn1 = wx.Button(self, BTN1, "Find My Alter-ego") # don't save a ref to this one
9416aa89	27	btns.Add(btn1)
8fa876ca RD	28	btns.Add((50, -1), 1, wx.EXPAND)
8fa876ca RD	29	self.btn2 = wx.Button(self, BTN2, "Find Myself")
9416aa89	30	btns.Add(self.btn2)
8fa876ca	31	btns.Add((50, -1), 1, wx.EXPAND)
9416aa89	32
8fa876ca	33	sizer.Add(btns, 0, wx.EXPAND\|wx.ALL, 15)
9416aa89 RD	34
9416aa89 RD	35	self.SetSizer(sizer)
1e4a197e	36	self.SetAutoLayout(True)
9416aa89	37
2aab8f16 RD	38	self.sizer = sizer # save it for testing later
2aab8f16 RD	39
8fa876ca RD	40	self.Bind(wx.EVT_BUTTON, self.OnFindButton1, id=BTN1)
8fa876ca RD	41	self.Bind(wx.EVT_BUTTON, self.OnFindButton2, id=BTN2)
9416aa89 RD	42
	43
	44	def OnFindButton1(self, evt):
	45	win = self.FindWindowById(BTN1)
8fa876ca	46
9416aa89 RD	47	if win is None:
	48	self.log.write("***** OOPS! None returned...\n")
	49	return
8fa876ca	50
9416aa89	51	className = win.__class__.__name__
8fa876ca RD	52
8fa876ca RD	53	if className in ["Button", "ButtonPtr"]:
9416aa89 RD	54	self.log.write("The types are the same! <grin>\n")
	55	else:
	56	self.log.write("Got %s, expected wxButton or wxButtonPtr\n" % className)
	57
	58
	59
	60	def OnFindButton2(self, evt):
	61	win = self.FindWindowById(BTN2)
8fa876ca	62
9416aa89 RD	63	if win is None:
	64	self.log.write("***** OOPS! None returned...\n")
	65	return
8fa876ca	66
9416aa89 RD	67	if win is self.btn2:
	68	self.log.write("The objects are the same! <grin>\n")
	69	else:
	70	self.log.write("The objects are NOT the same! <frown>\n")
	71
0122b7e3	72	win = evt.GetEventObject()
8fa876ca	73
0122b7e3 RD	74	if win is None:
	75	self.log.write("***** OOPS! None returned...\n")
	76	return
8fa876ca	77
0122b7e3	78	if win is self.btn2:
2aab8f16 RD	79	self.log.write("The objects are the same! <grin>\n")
	80	else:
	81	self.log.write("The objects are NOT the same! <frown>\n")
	82
	83	sizer = self.GetSizer()
8fa876ca	84
2aab8f16 RD	85	if sizer is None:
	86	self.log.write("***** OOPS! None returned...\n")
	87	return
8fa876ca	88
2aab8f16	89	if sizer is self.sizer:
0122b7e3 RD	90	self.log.write("The objects are the same! <grin>\n")
	91	else:
	92	self.log.write("The objects are NOT the same! <frown>\n")
	93
9416aa89 RD	94
	95	#----------------------------------------------------------------------
	96
	97	def runTest(frame, nb, log):
	98	win = TestPanel(nb, log)
	99	return win
	100
	101	#----------------------------------------------------------------------
	102
	103
	104	overview = """\
	105	<html><body>
	106	<h2>Original Object Return</h2>
	107
	108	<p>Several methods in wxWindows return pointers to base class objects,
	109	when in fact the actual object pointed to is of a derived type. Since
	110	SWIG isn't able to tell the actual type it just creates a new Python
	111	shadow object of the base type to wrap around the base type pointer
	112	and returns it.
	113
0122b7e3 RD	114	<p>In wxPython prior to 2.3.0 this could cause annoying issues. For
0122b7e3 RD	115	example if you called:
9416aa89 RD	116
	117	<pre>
	118
	119	myText = someWindow.FindWindowById(txtID)
	120	</pre>
	121
0122b7e3	122	expecting to get a wxTextCtrl you would actually get a wxWindow object
9416aa89 RD	123	instead. If you then try to call SetValue on that object you'll get
	124	an exception since there is no such method. This is the reason for
	125	the wxPyTypeCast hack that has been in wxPython for so long.
	126
0122b7e3 RD	127	<p>Even with wxPyTypeCast there was the issue that the object returned
0122b7e3 RD	128	was not the same one that was created in Python originally, but a new
9416aa89 RD	129	object of the same type that wraps the same C++ pointer. If the
	130	programmer has set additional attributes of that original object they
	131	will not exist in the new object.
	132
	133	<p>For a long time now I have wanted to do away with wxPyTypeCast and
	134	also find a way to return the original Python object from methods like
	135	FindWindowById. This project naturally divides into two phases:
	136
	137	<p><ol>
	138
	139	<li>Teach the wrapper methods how to return objects of the right type,
	140	and be able to then turn wxPyTypeCast in to a no-op.
	141
	142	<li>Be able to return the original Python shadow object if it still exists.
	143
	144	</ol>
	145
	146	<p>The first button below shows the first of these phases (<i>working</i>)
8fa876ca	147	and the second will show #2 (<i>working as of Python 2.3.2</i>)
9416aa89 RD	148
	149	</body></html>
	150	"""
1fded56b RD	151
	152
	153
	154
	155	if __name__ == '__main__':
	156	import sys,os
	157	import run
	158	run.main(['', os.path.basename(sys.argv[0])])
	159