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

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

import  wx

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

# The wxVListBox is much like a regular wxListBox except you draw the
# items yourself and the items can vary in height.
class MyVListBox(wx.VListBox):

    # This method must be overridden.  When called it should draw the
    # n'th item on the dc within the rect.  How it is drawn, and what
    # is drawn is entirely up to you.
    def OnDrawItem(self, dc, rect, n):
        dc.DrawLabel(self._getItemText(n), rect,
                     wx.ALIGN_LEFT | wx.ALIGN_CENTER_VERTICAL)

    # This method must be overridden.  It should return the height
    # required to draw the n'th item.
    def OnMeasureItem(self, n):
        height = 0

        for line in self._getItemText(n).split('\n'):
            w, h = self.GetTextExtent(line)
            height += h

        return height + 5


    # These are also overridable:
    #
    # OnDrawSeparator(dc, rect, n)
    #   Draw a separator between items.  Note that rect may be reduced
    #   in size if desired so OnDrawItem gets a smaller rect.
    #
    # OnDrawBackground(dc, rect, n)
    #   Draw the background and maybe a border if desired.


    def _getItemText(self, item):
        if item % 2 == 0:
            return "This is item# %d" % item
        else:
            return "This is item# %d\n with an extra line" % item

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

# The wx.HtmlListBox derives from wx.VListBox, but draws each item
# itself as a wx.HtmlCell.
class MyHtmlListBox(wx.HtmlListBox):

    def OnGetItem(self, n):
        if n % 2 == 0:
            return "This is item# <b>%d</b>" % n
        else:
            return "This is item# <b>%d</b> <br>Any <font color='RED'>HTML</font> is okay." % n

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

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

        vlb = MyVListBox(self, -1, size=(150, 250), style=wx.BORDER_SUNKEN)
        vlb.SetItemCount(50)
        vlb.SetSelection(0)
        vlb.SetFocus()
        vlbSizer = wx.BoxSizer(wx.VERTICAL)
        vlbSizer.Add((spacer, spacer))
        vlbSizer.Add(wx.StaticText(self, -1, "wx.VListBox"), 0, 5, wx.ALL)
        vlbSizer.Add(vlb)

        hlb = MyHtmlListBox(self, -1, size=(150, 250), style=wx.BORDER_SUNKEN)
        hlb.SetItemCount(50)
        hlb.SetSelection(0)
        hlbSizer = wx.BoxSizer(wx.VERTICAL)
        hlbSizer.Add((spacer, spacer))
        hlbSizer.Add(wx.StaticText(self, -1, "wx.HtmlListBox"), 0, 5, wx.ALL)
        hlbSizer.Add(hlb)

        sizer = wx.BoxSizer(wx.HORIZONTAL)
        sizer.Add((spacer, spacer))
        sizer.Add(vlbSizer)
        sizer.Add((spacer, spacer))
        sizer.Add((spacer, spacer))
        sizer.Add(hlbSizer)

        self.SetSizer(sizer)


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

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

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


overview = """<html><body>
<h2><center>wxVListBox and wxHtmlListBox</center></h2>
<hr>

The "V" in wxVListBox stands for both "virtual" because it can have an
unlimited number of items since it doesn't store them itself, and
"variable" since items can vary in height.  It has much the same
interface as wxListBox and also emits the same events so you can use
the same EVT_LISTBOX function to connect a handler.
<p>

The wxHtmlListBox derives from wxVListBox, but draws each item itself
as a wxHtmlCell.  This means that you just need to provide a snippet
of HTML for each item when requested.

</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/22/2003 - Jeff Grimmett (grimmtooth@softhome.net)
	2	#
	3	# o Updated for wx namespace
	4	#
3628e088	5
8fa876ca	6	import wx
3628e088 RD	7
	8	#----------------------------------------------------------------------
	9
	10	# The wxVListBox is much like a regular wxListBox except you draw the
	11	# items yourself and the items can vary in height.
8fa876ca	12	class MyVListBox(wx.VListBox):
3628e088 RD	13
	14	# This method must be overridden. When called it should draw the
	15	# n'th item on the dc within the rect. How it is drawn, and what
	16	# is drawn is entirely up to you.
	17	def OnDrawItem(self, dc, rect, n):
	18	dc.DrawLabel(self._getItemText(n), rect,
8fa876ca	19	wx.ALIGN_LEFT \| wx.ALIGN_CENTER_VERTICAL)
3628e088 RD	20
	21	# This method must be overridden. It should return the height
	22	# required to draw the n'th item.
	23	def OnMeasureItem(self, n):
	24	height = 0
8fa876ca	25
3628e088 RD	26	for line in self._getItemText(n).split('\n'):
	27	w, h = self.GetTextExtent(line)
	28	height += h
8fa876ca	29
3628e088 RD	30	return height + 5
	31
	32
	33	# These are also overridable:
	34	#
	35	# OnDrawSeparator(dc, rect, n)
	36	# Draw a separator between items. Note that rect may be reduced
	37	# in size if desired so OnDrawItem gets a smaller rect.
	38	#
	39	# OnDrawBackground(dc, rect, n)
	40	# Draw the background and maybe a border if desired.
	41
	42
	43	def _getItemText(self, item):
	44	if item % 2 == 0:
	45	return "This is item# %d" % item
	46	else:
	47	return "This is item# %d\n with an extra line" % item
	48
	49	#----------------------------------------------------------------------
	50
8fa876ca RD	51	# The wx.HtmlListBox derives from wx.VListBox, but draws each item
	52	# itself as a wx.HtmlCell.
	53	class MyHtmlListBox(wx.HtmlListBox):
3628e088 RD	54
	55	def OnGetItem(self, n):
	56	if n % 2 == 0:
	57	return "This is item# <b>%d</b>" % n
	58	else:
	59	return "This is item# <b>%d</b> <br>Any <font color='RED'>HTML</font> is okay." % n
	60
	61	#----------------------------------------------------------------------
	62
8fa876ca	63	class TestPanel(wx.Panel):
3628e088 RD	64	def __init__(self, parent, log):
3628e088 RD	65	self.log = log
8fa876ca	66	wx.Panel.__init__(self, parent, -1)
3628e088 RD	67	spacer = 50
3628e088 RD	68
8fa876ca	69	vlb = MyVListBox(self, -1, size=(150, 250), style=wx.BORDER_SUNKEN)
3628e088 RD	70	vlb.SetItemCount(50)
	71	vlb.SetSelection(0)
	72	vlb.SetFocus()
8fa876ca	73	vlbSizer = wx.BoxSizer(wx.VERTICAL)
3628e088	74	vlbSizer.Add((spacer, spacer))
8fa876ca	75	vlbSizer.Add(wx.StaticText(self, -1, "wx.VListBox"), 0, 5, wx.ALL)
3628e088 RD	76	vlbSizer.Add(vlb)
3628e088 RD	77
8fa876ca	78	hlb = MyHtmlListBox(self, -1, size=(150, 250), style=wx.BORDER_SUNKEN)
3628e088 RD	79	hlb.SetItemCount(50)
3628e088 RD	80	hlb.SetSelection(0)
8fa876ca	81	hlbSizer = wx.BoxSizer(wx.VERTICAL)
3628e088	82	hlbSizer.Add((spacer, spacer))
8fa876ca	83	hlbSizer.Add(wx.StaticText(self, -1, "wx.HtmlListBox"), 0, 5, wx.ALL)
3628e088 RD	84	hlbSizer.Add(hlb)
3628e088 RD	85
8fa876ca	86	sizer = wx.BoxSizer(wx.HORIZONTAL)
3628e088 RD	87	sizer.Add((spacer, spacer))
	88	sizer.Add(vlbSizer)
	89	sizer.Add((spacer, spacer))
	90	sizer.Add((spacer, spacer))
	91	sizer.Add(hlbSizer)
	92
	93	self.SetSizer(sizer)
	94
	95
	96	#----------------------------------------------------------------------
	97
	98	def runTest(frame, nb, log):
	99	win = TestPanel(nb, log)
	100	return win
	101
	102	#----------------------------------------------------------------------
	103
	104
	105
	106	overview = """<html><body>
	107	<h2><center>wxVListBox and wxHtmlListBox</center></h2>
	108	<hr>
	109
	110	The "V" in wxVListBox stands for both "virtual" because it can have an
	111	unlimited number of items since it doesn't store them itself, and
	112	"variable" since items can vary in height. It has much the same
	113	interface as wxListBox and also emits the same events so you can use
	114	the same EVT_LISTBOX function to connect a handler.
	115	<p>
	116
	117	The wxHtmlListBox derives from wxVListBox, but draws each item itself
	118	as a wxHtmlCell. This means that you just need to provide a snippet
	119	of HTML for each item when requested.
	120
	121	</body></html>
	122	"""
	123
	124
	125
	126	if __name__ == '__main__':
	127	import sys,os
	128	import run
	129	run.main(['', os.path.basename(sys.argv[0])])
	130