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


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