From 54636d4121071f76fba049e5d4fae1342a788c97 2007-05-09 23:07:19
From: walter.doerwald
Date: 2007-05-09 23:07:19
Subject: [PATCH] Incorporate html help into the module, so we don't have to search for the file.
---
diff --git a/IPython/Extensions/igrid.py b/IPython/Extensions/igrid.py
index fdc5ea7..4bd7731 100644
--- a/IPython/Extensions/igrid.py
+++ b/IPython/Extensions/igrid.py
@@ -13,6 +13,96 @@ except NameError:
__all__ = ["igrid"]
+help = """
+
+
+
+
+
+
+igrid help
+
+
+
igrid help
+
+
+
Commands
+
+
+
pick (P)
+
Pick the whole row (object is available as "_")
+
+
pickattr (Shift-P)
+
Pick the attribute under the cursor
+
+
pickallattrs (Shift-C)
+
Pick' the complete column under the cursor (i.e. the attribute under the
+cursor) from all currently fetched objects. These attributes will be returned
+as a list.
+
+
enter (E)
+
Enter the object under the cursor. (what this mean depends on the object
+itself, i.e. how it implements iteration). This opens a new browser 'level'.
+
+
enterattr (Shift-E)
+
Enter the attribute under the cursor.
+
+
detail (D)
+
Show a detail view of the object under the cursor. This shows the name,
+type, doc string and value of the object attributes (and it might show more
+attributes than in the list view, depending on the object).
+
+
detailattr (Shift-D)
+
Show a detail view of the attribute under the cursor.
+
+
pickrows (M)
+
Pick multiple selected rows (M)
+
+
pickrowsattr (CTRL-M)
+
From multiple selected rows pick the cells matching the attribute the cursor is in (CTRL-M)
+
+
find (CTRL-F)
+
Find text
+
+
find_next (F3)
+
Find next occurrence of the searchtext
+
+
find_previous (Shift-F3)
+
Find previous occurrence of the searchtext
+
+
sortattrasc (V)
+
Sort the objects (in ascending order) using the attribute under the cursor as the sort key.
+
+
sortattrdesc (Shift-V)
+
Sort the objects (in descending order) using the attribute under the cursor as the sort key.
+
+
leave (Backspace, DEL, X)
+
Close current tab (and all the tabs to the right of the current one).
+
+
quit (ESC,Q)
+
Quit igrid and return to the IPython prompt.
+
+
+
Navigation
+
+
+
Jump to the last column of the current row (END, CTRL-E, CTRL-Right)
+
+
Jump to the first column of the current row (HOME, CTRL-A, CTRL-Left)
+
+
Move the cursor one column to the left (<)
+
+
Move the cursor one column to the right (>)
+
+
Jump to the first row in the current column (CTRL-Up)
+
+
Jump to the last row in the current column (CTRL-Down)
+
+
+
+"""
+
+
class IGridRenderer(wx.grid.PyGridCellRenderer):
"""
This is a custom renderer for our IGridGrid
@@ -655,12 +745,12 @@ class IGridPanel(wx.Panel):
class IGridHTMLHelp(wx.Frame):
- def __init__(self, parent, title, filename, size):
+ def __init__(self, parent, title, size):
wx.Frame.__init__(self, parent, -1, title, size=size)
html = wx.html.HtmlWindow(self)
if "gtk2" in wx.PlatformInfo:
html.SetStandardFonts()
- html.LoadFile(filename)
+ html.SetPage(help)
class IGridFrame(wx.Frame):
@@ -738,8 +828,7 @@ class IGridFrame(wx.Frame):
"""
if self.helpdialog:
self.helpdialog.Destroy()
- filename = os.path.join(os.path.dirname(__file__), "igrid_help.html")
- self.helpdialog = IGridHTMLHelp(None, title="Help", filename=filename, size=wx.Size(600,400))
+ self.helpdialog = IGridHTMLHelp(None, title="Help", size=wx.Size(600,400))
self.helpdialog.Show()
def display_help_in_browser(self, event):
diff --git a/doc/ChangeLog b/doc/ChangeLog
index f05bc4d..ebfd30b 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2007-05-10 Walter Doerwald
+
+ * IPython/Extensions/igrid.py: Incorporate html help into
+ the module, so we don't have to search for the file.
+
2007-05-02 Fernando Perez
* test/test_irunner.py (RunnerTestCase._test_runner): Close #147.