##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

Incorporate html help into the module, so we don't have to search for the file.
walter.doerwald -
Show More
Show file before | Show file after | Hide comments
@@ -13,6 +13,96 b' except NameError:'
13 __all__ = ["igrid"]
13 __all__ = ["igrid"]
14
14
15
15
16 help = """
17 <?xml version='1.0' encoding='iso-8859-1'?>
18 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
19 <html>
20 <head>
21 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
22 <link rel="stylesheet" href="igrid_help.css" type="text/css" />
23 <title>igrid help</title>
24 </head>
25 <body>
26 <h1>igrid help</h1>
27
28
29 <h2>Commands</h2>
30
31
32 <h3>pick (P)</h3>
33 <p>Pick the whole row (object is available as "_")</p>
34
35 <h3>pickattr (Shift-P)</h3>
36 <p>Pick the attribute under the cursor</p>
37
38 <h3>pickallattrs (Shift-C)</h3>
39 <p>Pick' the complete column under the cursor (i.e. the attribute under the
40 cursor) from all currently fetched objects. These attributes will be returned
41 as a list.</p>
42
43 <h3>enter (E)</h3>
44 <p>Enter the object under the cursor. (what this mean depends on the object
45 itself, i.e. how it implements iteration). This opens a new browser 'level'.</p>
46
47 <h3>enterattr (Shift-E)</h3>
48 <p>Enter the attribute under the cursor.</p>
49
50 <h3>detail (D)</h3>
51 <p>Show a detail view of the object under the cursor. This shows the name,
52 type, doc string and value of the object attributes (and it might show more
53 attributes than in the list view, depending on the object).</p>
54
55 <h3>detailattr (Shift-D)</h3>
56 <p>Show a detail view of the attribute under the cursor.</p>
57
58 <h3>pickrows (M)</h3>
59 <p>Pick multiple selected rows (M)</p>
60
61 <h3>pickrowsattr (CTRL-M)</h3>
62 <p>From multiple selected rows pick the cells matching the attribute the cursor is in (CTRL-M)</p>
63
64 <h3>find (CTRL-F)</h3>
65 <p>Find text</p>
66
67 <h3>find_next (F3)</h3>
68 <p>Find next occurrence of the searchtext</p>
69
70 <h3>find_previous (Shift-F3)</h3>
71 <p>Find previous occurrence of the searchtext </p>
72
73 <h3>sortattrasc (V)</h3>
74 <p>Sort the objects (in ascending order) using the attribute under the cursor as the sort key.</p>
75
76 <h3>sortattrdesc (Shift-V)</h3>
77 <p>Sort the objects (in descending order) using the attribute under the cursor as the sort key.</p>
78
79 <h3>leave (Backspace, DEL, X)</h3>
80 <p>Close current tab (and all the tabs to the right of the current one).</h3>
81
82 <h3>quit (ESC,Q)</h3>
83 <p>Quit igrid and return to the IPython prompt.</p>
84
85
86 <h2>Navigation</h2>
87
88
89 <h3>Jump to the last column of the current row (END, CTRL-E, CTRL-Right)</h3>
90
91 <h3>Jump to the first column of the current row (HOME, CTRL-A, CTRL-Left)</h3>
92
93 <h3>Move the cursor one column to the left (&lt;)</h3>
94
95 <h3>Move the cursor one column to the right (&gt;)</h3>
96
97 <h3>Jump to the first row in the current column (CTRL-Up)</h3>
98
99 <h3>Jump to the last row in the current column (CTRL-Down)</h3>
100
101 </body>
102 </html>
103 """
104
105
16 class IGridRenderer(wx.grid.PyGridCellRenderer):
106 class IGridRenderer(wx.grid.PyGridCellRenderer):
17 """
107 """
18 This is a custom renderer for our IGridGrid
108 This is a custom renderer for our IGridGrid
@@ -655,12 +745,12 b' class IGridPanel(wx.Panel):'
655
745
656
746
657 class IGridHTMLHelp(wx.Frame):
747 class IGridHTMLHelp(wx.Frame):
658 def __init__(self, parent, title, filename, size):
748 def __init__(self, parent, title, size):
659 wx.Frame.__init__(self, parent, -1, title, size=size)
749 wx.Frame.__init__(self, parent, -1, title, size=size)
660 html = wx.html.HtmlWindow(self)
750 html = wx.html.HtmlWindow(self)
661 if "gtk2" in wx.PlatformInfo:
751 if "gtk2" in wx.PlatformInfo:
662 html.SetStandardFonts()
752 html.SetStandardFonts()
663 html.LoadFile(filename)
753 html.SetPage(help)
664
754
665
755
666 class IGridFrame(wx.Frame):
756 class IGridFrame(wx.Frame):
@@ -738,8 +828,7 b' class IGridFrame(wx.Frame):'
738 """
828 """
739 if self.helpdialog:
829 if self.helpdialog:
740 self.helpdialog.Destroy()
830 self.helpdialog.Destroy()
741 filename = os.path.join(os.path.dirname(__file__), "igrid_help.html")
831 self.helpdialog = IGridHTMLHelp(None, title="Help", size=wx.Size(600,400))
742 self.helpdialog = IGridHTMLHelp(None, title="Help", filename=filename, size=wx.Size(600,400))
743 self.helpdialog.Show()
832 self.helpdialog.Show()
744
833
745 def display_help_in_browser(self, event):
834 def display_help_in_browser(self, event):
Show file before | Show file after | Hide comments
@@ -1,3 +1,8 b''
1 2007-05-10 Walter Doerwald <walter@livinglogic.de>
2
3 * IPython/Extensions/igrid.py: Incorporate html help into
4 the module, so we don't have to search for the file.
5
1 2007-05-02 Fernando Perez <Fernando.Perez@colorado.edu>
6 2007-05-02 Fernando Perez <Fernando.Perez@colorado.edu>
2
7
3 * test/test_irunner.py (RunnerTestCase._test_runner): Close #147.
8 * test/test_irunner.py (RunnerTestCase._test_runner): Close #147.
General Comments 0
You need to be logged in to leave comments. Login now