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

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

import  os
import  wx

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

text = """\
Right-click on the panel above the line to get a menu.  This menu will 
be managed by a FileHistory object and so the files you select will 
automatically be added to the end of the menu and will be selectable 
the next time the menu is viewed.  The filename selected, either via the 
Open menu item, or from the history, will be displayed in the log 
window below.
"""

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

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

        # Make and layout the controls
        fs = self.GetFont().GetPointSize()
        bf = wx.Font(fs+4, wx.SWISS, wx.NORMAL, wx.BOLD)
        nf = wx.Font(fs+2, wx.SWISS, wx.NORMAL, wx.NORMAL)

        t = wx.StaticText(self, -1, "FileHistory")
        t.SetFont(bf)
        box.Add(t, 0, wx.CENTER|wx.ALL, 5)

        box.Add(wx.StaticLine(self, -1), 0, wx.EXPAND)
        box.Add((10,20))

        t = wx.StaticText(self, -1, text)
        t.SetFont(nf)
        box.Add(t, 0, wx.CENTER|wx.ALL, 5)

        self.SetSizer(box)
        self.SetAutoLayout(True)

        # Make a menu
        self.menu = m = wx.Menu()

        # Little know wx Fact #42: there are a number of pre-set IDs
        # in the wx package, to be used for common controls such as those
        # illustrated below. Neat, huh?
        m.Append(wx.ID_NEW,     "&New")
        m.Append(wx.ID_OPEN,    "&Open...")
        m.Append(wx.ID_CLOSE,   "&Close")
        m.Append(wx.ID_SAVE,    "&Save")
        m.Append(wx.ID_SAVEAS,  "Save &as...")
        m.Enable(wx.ID_NEW, False)
        m.Enable(wx.ID_CLOSE, False)
        m.Enable(wx.ID_SAVE, False)
        m.Enable(wx.ID_SAVEAS, False)

        # and a file history
        self.filehistory = wx.FileHistory()
        self.filehistory.UseMenu(self.menu)

        # and finally the event handler bindings
        self.Bind(wx.EVT_RIGHT_UP, self.OnRightClick)

        self.Bind(wx.EVT_MENU, self.OnFileOpenDialog, id=wx.ID_OPEN)

        self.Bind(
            wx.EVT_MENU_RANGE, self.OnFileHistory, id=wx.ID_FILE1, id2=wx.ID_FILE9
            )

        self.Bind(wx.EVT_WINDOW_DESTROY, self.Cleanup)


    def Cleanup(self, *args):
        # A little extra cleanup is required for the FileHistory control
        del self.filehistory
        self.menu.Destroy()


    def OnRightClick(self, evt):
        self.PopupMenu(self.menu, evt.GetPosition())


    def OnFileOpenDialog(self, evt):
        dlg = wx.FileDialog(self,
                           defaultDir = os.getcwd(),
                           wildcard = "All Files|*",
                           style = wx.OPEN | wx.CHANGE_DIR)

        if dlg.ShowModal() == wx.ID_OK:
            path = dlg.GetPath()
            self.log.write("You selected %s\n" % path)

            # add it to the history
            self.filehistory.AddFileToHistory(path)

        dlg.Destroy()


    def OnFileHistory(self, evt):
        # get the file based on the menu ID
        fileNum = evt.GetId() - wx.ID_FILE1
        path = self.filehistory.GetHistoryFile(fileNum)
        self.log.write("You selected %s\n" % path)

        # add it back to the history so it will be moved up the list
        self.filehistory.AddFileToHistory(path)


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

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

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


overview = """<html><body>
<h3>FileHistory</h3>

wxFileHistory encapsulates functionality to record the last few files
visited, and to allow the user to quickly load these files using the
list appended to a menu, such as the File menu.

<p>Note that this inclusion is not automatic; as illustrated in this example,
you must add files (and remove them) as deemed necessary within the framework
of your program. 

<p>Note also the additional cleanup required for this class, namely trapping the
enclosing window's Destroy event and deleting the file history control and its
associated menu.
</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/17/2003 - Jeff Grimmett (grimmtooth@softhome.net)
	2	#
	3	# o Updated for wx namespace
	4	#
7c41d11a	5
8fa876ca RD	6	import os
8fa876ca RD	7	import wx
7c41d11a RD	8
	9	#----------------------------------------------------------------------
	10
	11	text = """\
8fa876ca RD	12	Right-click on the panel above the line to get a menu. This menu will
	13	be managed by a FileHistory object and so the files you select will
	14	automatically be added to the end of the menu and will be selectable
	15	the next time the menu is viewed. The filename selected, either via the
	16	Open menu item, or from the history, will be displayed in the log
	17	window below.
7c41d11a RD	18	"""
	19
	20	#----------------------------------------------------------------------
	21
8fa876ca	22	class TestPanel(wx.Panel):
7c41d11a RD	23	def __init__(self, parent, log):
7c41d11a RD	24	self.log = log
8fa876ca RD	25	wx.Panel.__init__(self, parent, -1)
8fa876ca RD	26	box = wx.BoxSizer(wx.VERTICAL)
7c41d11a RD	27
7c41d11a RD	28	# Make and layout the controls
d3bfec74	29	fs = self.GetFont().GetPointSize()
8fa876ca RD	30	bf = wx.Font(fs+4, wx.SWISS, wx.NORMAL, wx.BOLD)
8fa876ca RD	31	nf = wx.Font(fs+2, wx.SWISS, wx.NORMAL, wx.NORMAL)
7c41d11a	32
8fa876ca	33	t = wx.StaticText(self, -1, "FileHistory")
7c41d11a	34	t.SetFont(bf)
8fa876ca	35	box.Add(t, 0, wx.CENTER\|wx.ALL, 5)
7c41d11a	36
8fa876ca	37	box.Add(wx.StaticLine(self, -1), 0, wx.EXPAND)
d14a1e28	38	box.Add((10,20))
7c41d11a	39
8fa876ca	40	t = wx.StaticText(self, -1, text)
7c41d11a	41	t.SetFont(nf)
8fa876ca	42	box.Add(t, 0, wx.CENTER\|wx.ALL, 5)
7c41d11a RD	43
7c41d11a RD	44	self.SetSizer(box)
1e4a197e	45	self.SetAutoLayout(True)
7c41d11a RD	46
7c41d11a RD	47	# Make a menu
8fa876ca RD	48	self.menu = m = wx.Menu()
	49
	50	# Little know wx Fact #42: there are a number of pre-set IDs
	51	# in the wx package, to be used for common controls such as those
	52	# illustrated below. Neat, huh?
	53	m.Append(wx.ID_NEW, "&New")
	54	m.Append(wx.ID_OPEN, "&Open...")
	55	m.Append(wx.ID_CLOSE, "&Close")
	56	m.Append(wx.ID_SAVE, "&Save")
	57	m.Append(wx.ID_SAVEAS, "Save &as...")
	58	m.Enable(wx.ID_NEW, False)
	59	m.Enable(wx.ID_CLOSE, False)
	60	m.Enable(wx.ID_SAVE, False)
	61	m.Enable(wx.ID_SAVEAS, False)
7c41d11a RD	62
7c41d11a RD	63	# and a file history
8fa876ca	64	self.filehistory = wx.FileHistory()
7c41d11a RD	65	self.filehistory.UseMenu(self.menu)
	66
	67	# and finally the event handler bindings
8fa876ca RD	68	self.Bind(wx.EVT_RIGHT_UP, self.OnRightClick)
	69
	70	self.Bind(wx.EVT_MENU, self.OnFileOpenDialog, id=wx.ID_OPEN)
	71
	72	self.Bind(
	73	wx.EVT_MENU_RANGE, self.OnFileHistory, id=wx.ID_FILE1, id2=wx.ID_FILE9
	74	)
	75
	76	self.Bind(wx.EVT_WINDOW_DESTROY, self.Cleanup)
7c41d11a RD	77
7c41d11a RD	78
f2a10cdc	79	def Cleanup(self, *args):
8fa876ca	80	# A little extra cleanup is required for the FileHistory control
7c41d11a RD	81	del self.filehistory
	82	self.menu.Destroy()
	83
	84
	85	def OnRightClick(self, evt):
	86	self.PopupMenu(self.menu, evt.GetPosition())
	87
	88
	89	def OnFileOpenDialog(self, evt):
8fa876ca	90	dlg = wx.FileDialog(self,
7c41d11a	91	defaultDir = os.getcwd(),
93214200	92	wildcard = "All Files\|*",
8fa876ca RD	93	style = wx.OPEN \| wx.CHANGE_DIR)
	94
	95	if dlg.ShowModal() == wx.ID_OK:
7c41d11a RD	96	path = dlg.GetPath()
	97	self.log.write("You selected %s\n" % path)
	98
	99	# add it to the history
	100	self.filehistory.AddFileToHistory(path)
	101
	102	dlg.Destroy()
	103
	104
	105	def OnFileHistory(self, evt):
	106	# get the file based on the menu ID
8fa876ca	107	fileNum = evt.GetId() - wx.ID_FILE1
7c41d11a RD	108	path = self.filehistory.GetHistoryFile(fileNum)
	109	self.log.write("You selected %s\n" % path)
	110
	111	# add it back to the history so it will be moved up the list
	112	self.filehistory.AddFileToHistory(path)
	113
	114
	115
	116	#----------------------------------------------------------------------
	117
	118	def runTest(frame, nb, log):
	119	win = TestPanel(nb, log)
	120	return win
	121
	122	#----------------------------------------------------------------------
	123
	124
	125
	126	overview = """<html><body>
8fa876ca	127	<h3>FileHistory</h3>
7c41d11a RD	128
	129	wxFileHistory encapsulates functionality to record the last few files
	130	visited, and to allow the user to quickly load these files using the
	131	list appended to a menu, such as the File menu.
	132
8fa876ca RD	133	<p>Note that this inclusion is not automatic; as illustrated in this example,
	134	you must add files (and remove them) as deemed necessary within the framework
	135	of your program.
	136
	137	<p>Note also the additional cleanup required for this class, namely trapping the
	138	enclosing window's Destroy event and deleting the file history control and its
	139	associated menu.
7c41d11a RD	140	</body></html>
7c41d11a RD	141	"""
93214200 RD	142
93214200 RD	143	if __name__ == '__main__':
8641d30c	144	import sys,os
93214200	145	import run
8641d30c	146	run.main(['', os.path.basename(sys.argv[0])])
93214200	147