Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

some docstring fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39667 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2006-06-11 00:13:05 +00:00
parent 35d8bffe01
commit 9f4cc34f37
14 changed files with 312 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
wxPython/docs/bin/makeapidocs
View File

@@ -15,7 +15,7 @@ rm -r docs/api/*
# build the docs # build the docs
export PTYHONPATH=$PWD export PTYHONPATH=$PWD
epydoc --name wxPython \ /opt/python/bin/epydoc --name wxPython \
--html \ --html \
--output docs/api \ --output docs/api \
--ignore-param-mismatch \ --ignore-param-mismatch \
@@ -52,9 +52,9 @@ DEST=wxPython-$VERSION/docs
mkdir -p _build_docs/$DEST mkdir -p _build_docs/$DEST
cp -R --link docs/api _build_docs/$DEST cp -R --link docs/api _build_docs/$DEST
cd _build_docs cd _build_docs
rm -f ../dist/wxPython-newdocs-$VERSION.tar.gz rm -f ../dist/wxPython-newdocs-$VERSION.tar.bz2
tar cf ../dist/wxPython-newdocs-$VERSION.tar $DEST tar cf ../dist/wxPython-newdocs-$VERSION.tar $DEST
gzip -9 ../dist/wxPython-newdocs-$VERSION.tar bzip2 -9 ../dist/wxPython-newdocs-$VERSION.tar
# Cleanup # Cleanup
cd .. cd ..

2
wxPython/wx/lib/docview.py
View File

@@ -1039,7 +1039,7 @@ class DocTemplate(wx.Object):
string will be displayed in the file filter list of Windows file string will be displayed in the file filter list of Windows file
selectors. selectors.
filter is an appropriate file filter such as *.txt. filter is an appropriate file filter such as \*.txt.
dir is the default directory to use for file selectors. dir is the default directory to use for file selectors.

2
wxPython/wx/lib/foldpanelbar.py
View File

@@ -1005,7 +1005,7 @@ class FoldPanelBar(wx.Panel):
This control is easy to use. Simply create it as a child for a This control is easy to use. Simply create it as a child for a
panel or sash window, and populate panels with panel or sash window, and populate panels with
`AddFoldPanel`. Then use the `AdddFoldPanelWindow` to add `AddFoldPanel`. Then use the `AddFoldPanelWindow` to add
`wx.Window` derived controls to the current fold panel. Use `wx.Window` derived controls to the current fold panel. Use
`AddFoldPanelSeparator` to put separators between the groups of `AddFoldPanelSeparator` to put separators between the groups of
controls that need a visual separator to group them controls that need a visual separator to group them

2
wxPython/wx/lib/gestures.py
View File

@@ -41,7 +41,7 @@ Not Yet Implemented
The criteria for a direction is as follows: The criteria for a direction is as follows:
x in a row. (Where x is the WobbleTolerance). x in a row. (Where x is the WobbleTolerance).
So if the WobbleTolerance is 9 So if the WobbleTolerance is 9
'URUUUUUUUUUUUUUUURUURUUUU1' is Up. 'URUUUUUUUUUUUUUUURUURUUUU1' is Up.
The higher this number, the less sensitive this class is. The higher this number, the less sensitive this class is.
So the more likely something like 1L will translate to 1. So the more likely something like 1L will translate to 1.

10
wxPython/wx/lib/infoframe.py
View File

@@ -32,23 +32,25 @@ Please note that, like wxPyOnDemandOutputWindow, the instance is not
itself a subclass of wxWindow: when the window is open (and ONLY itself a subclass of wxWindow: when the window is open (and ONLY
then), it's "frame" attribute is the actual instance of wFrame... then), it's "frame" attribute is the actual instance of wFrame...
Typical usage: Typical usage::
from wxPython.lib.infoframe import * from wxPython.lib.infoframe import *
... # ... modify your wxApp as follows: ... # ... modify your wxApp as follows:
class myApp(wxApp): class myApp(wxApp):
outputWindowClass = PyInformationalMessagesFrame outputWindowClass = PyInformationalMessagesFrame
... ...
If you're running on Linux, you'll also have to supply an argument 1 to your If you're running on Linux, you'll also have to supply an argument 1 to your
constructor of myApp to redirect stdout/stderr to this window (it's done constructor of myApp to redirect stdout/stderr to this window (it's done
automatically for you on Windows). automatically for you on Windows).
If you don't want to redirect stdout/stderr, but use the class directly: do If you don't want to redirect stdout/stderr, but use the class directly: do
it this way: it this way::
InformationalMessagesFrame = PyInformationalMessagesFrame\ InformationalMessagesFrame = PyInformationalMessagesFrame\
([options from progname (default ""), ([options from progname (default ""),
txt (default "informational txt (default "informational messages"])
messages"])
#^^^^ early in the program #^^^^ early in the program
... ...
InformationalMessagesFrame([comma-separated list of items to InformationalMessagesFrame([comma-separated list of items to

13
wxPython/wx/lib/mixins/listctrl.py
View File

@@ -702,12 +702,17 @@ class CheckListCtrlMixin:
""" """
This is a mixin for ListCtrl which add a checkbox in the first This is a mixin for ListCtrl which add a checkbox in the first
column of each row. It is inspired by limodou's CheckList.py(which column of each row. It is inspired by limodou's CheckList.py(which
can be got from his NewEdit) and improved: can be got from his NewEdit) and improved:
- You can just use InsertStringItem() to insert new items; - You can just use InsertStringItem() to insert new items;
- Once a checkbox is checked/unchecked, the corresponding item is not
selected; - Once a checkbox is checked/unchecked, the corresponding item
is not selected;
- You can use SetItemData() and GetItemData(); - You can use SetItemData() and GetItemData();
- Interfaces are changed to OnCheckItem(), IsChecked(), CheckItem().
- Interfaces are changed to OnCheckItem(), IsChecked(),
CheckItem().
You should not set a imagelist for the ListCtrl once this mixin is used. You should not set a imagelist for the ListCtrl once this mixin is used.
""" """

283
wxPython/wx/lib/plot.py
View File

@@ -121,7 +121,8 @@ class PolyPoints:
""" """
def __init__(self, points, attr): def __init__(self, points, attr):
self.points = _Numeric.array(points) self._points = _Numeric.array(points).astype(_Numeric.Float64)
self._logscale = (False, False)
self.currentScale= (1,1) self.currentScale= (1,1)
self.currentShift= (0,0) self.currentShift= (0,0)
self.scaled = self.points self.scaled = self.points
@@ -132,12 +133,34 @@ class PolyPoints:
raise KeyError, "Style attribute incorrect. Should be one of %s" % self._attributes.keys() raise KeyError, "Style attribute incorrect. Should be one of %s" % self._attributes.keys()
self.attributes[name] = value self.attributes[name] = value
def setLogScale(self, logscale):
self._logscale = logscale
def __getattr__(self, name):
if name == 'points':
if len(self._points)>0:
data = _Numeric.array(self._points,copy=True)
if self._logscale[0]:
data = self.log10(data, 0)
if self._logscale[1]:
data = self.log10(data, 1)
return data
else:
return self._points
else:
raise AttributeError, name
def log10(self, data, ind):
data = _Numeric.compress(data[:,ind]>0,data,0)
data[:,ind] = _Numeric.log10(data[:,ind])
return data
def boundingBox(self): def boundingBox(self):
if len(self.points) == 0: if len(self.points) == 0:
# no curves to draw # no curves to draw
# defaults to (-1,-1) and (1,1) but axis can be set in Draw # defaults to (-1,-1) and (1,1) but axis can be set in Draw
minXY= _Numeric.array([-1,-1]) minXY= _Numeric.array([-1.0,-1.0])
maxXY= _Numeric.array([ 1, 1]) maxXY= _Numeric.array([ 1.0, 1.0])
else: else:
minXY= _Numeric.minimum.reduce(self.points) minXY= _Numeric.minimum.reduce(self.points)
maxXY= _Numeric.maximum.reduce(self.points) maxXY= _Numeric.maximum.reduce(self.points)
@@ -353,6 +376,14 @@ class PlotGraphics:
self.xLabel= xLabel self.xLabel= xLabel
self.yLabel= yLabel self.yLabel= yLabel
def setLogScale(self, logscale):
if type(logscale) != tuple:
raise TypeError, 'logscale must be a tuple of bools, e.g. (False, False)'
if len(self.objects) == 0:
return
for o in self.objects:
o.setLogScale(logscale)
def boundingBox(self): def boundingBox(self):
p1, p2 = self.objects[0].boundingBox() p1, p2 = self.objects[0].boundingBox()
for o in self.objects[1:]: for o in self.objects[1:]:
@@ -439,7 +470,6 @@ class PlotCanvas(wx.Panel):
sizer = wx.FlexGridSizer(2,2,0,0) sizer = wx.FlexGridSizer(2,2,0,0)
self.canvas = wx.Window(self, -1) self.canvas = wx.Window(self, -1)
#self.canvas.SetMinSize((10,10))
self.sb_vert = wx.ScrollBar(self, -1, style=wx.SB_VERTICAL) self.sb_vert = wx.ScrollBar(self, -1, style=wx.SB_VERTICAL)
self.sb_vert.SetScrollbar(0,1000,1000,1000) self.sb_vert.SetScrollbar(0,1000,1000,1000)
self.sb_hor = wx.ScrollBar(self, -1, style=wx.SB_HORIZONTAL) self.sb_hor = wx.ScrollBar(self, -1, style=wx.SB_HORIZONTAL)
@@ -449,17 +479,18 @@ class PlotCanvas(wx.Panel):
sizer.Add(self.sb_vert, 0, wx.EXPAND) sizer.Add(self.sb_vert, 0, wx.EXPAND)
sizer.Add(self.sb_hor, 0, wx.EXPAND) sizer.Add(self.sb_hor, 0, wx.EXPAND)
sizer.Add((0,0)) sizer.Add((0,0))
#corner = wx.Window(self)
#corner.SetMinSize((0,0))
#sizer.Add(corner, 0, wx.EXPAND)
sizer.AddGrowableRow(0, 1) sizer.AddGrowableRow(0, 1)
sizer.AddGrowableCol(0, 1) sizer.AddGrowableCol(0, 1)
self.sb_vert.Show(False) self.sb_vert.Show(False)
self.sb_hor.Show(False) self.sb_hor.Show(False)
self.SetSizer(sizer) self.SetSizer(sizer)
self.Fit() self.Fit()
self.border = (1,1)
self.SetBackgroundColour("white") self.SetBackgroundColour("white")
# Create some mouse events for zooming # Create some mouse events for zooming
@@ -504,6 +535,8 @@ class PlotCanvas(wx.Panel):
self._dragEnabled = False self._dragEnabled = False
self._screenCoordinates = _Numeric.array([0.0, 0.0]) self._screenCoordinates = _Numeric.array([0.0, 0.0])
self._logscale = (False, False)
# Zooming variables # Zooming variables
self._zoomInFactor = 0.5 self._zoomInFactor = 0.5
self._zoomOutFactor = 2 self._zoomOutFactor = 2
@@ -660,6 +693,20 @@ class PlotCanvas(wx.Panel):
frame.Centre(wx.BOTH) frame.Centre(wx.BOTH)
frame.Show(True) frame.Show(True)
def setLogScale(self, logscale):
if type(logscale) != tuple:
raise TypeError, 'logscale must be a tuple of bools, e.g. (False, False)'
if self.last_draw is not None:
graphics, xAxis, yAxis= self.last_draw
graphics.setLogScale(logscale)
self.last_draw = (graphics, None, None)
self.SetXSpec('min')
self.SetYSpec('min')
self._logscale = logscale
def getLogScale(self):
return self._logscale
def SetFontSizeAxis(self, point= 10): def SetFontSizeAxis(self, point= 10):
"""Set the tick and axis label font size (default is 10 point)""" """Set the tick and axis label font size (default is 10 point)"""
self._fontSizeAxis= point self._fontSizeAxis= point
@@ -777,7 +824,7 @@ class PlotCanvas(wx.Panel):
"""Unzoom the plot.""" """Unzoom the plot."""
self.last_PointLabel = None #reset pointLabel self.last_PointLabel = None #reset pointLabel
if self.last_draw is not None: if self.last_draw is not None:
self.Draw(self.last_draw[0]) self._Draw(self.last_draw[0])
def ScrollRight(self, units): def ScrollRight(self, units):
"""Move view right number of axis units.""" """Move view right number of axis units."""
@@ -785,7 +832,7 @@ class PlotCanvas(wx.Panel):
if self.last_draw is not None: if self.last_draw is not None:
graphics, xAxis, yAxis= self.last_draw graphics, xAxis, yAxis= self.last_draw
xAxis= (xAxis[0]+units, xAxis[1]+units) xAxis= (xAxis[0]+units, xAxis[1]+units)
self.Draw(graphics,xAxis,yAxis) self._Draw(graphics,xAxis,yAxis)
def ScrollUp(self, units): def ScrollUp(self, units):
"""Move view up number of axis units.""" """Move view up number of axis units."""
@@ -793,10 +840,18 @@ class PlotCanvas(wx.Panel):
if self.last_draw is not None: if self.last_draw is not None:
graphics, xAxis, yAxis= self.last_draw graphics, xAxis, yAxis= self.last_draw
yAxis= (yAxis[0]+units, yAxis[1]+units) yAxis= (yAxis[0]+units, yAxis[1]+units)
self.Draw(graphics,xAxis,yAxis) self._Draw(graphics,xAxis,yAxis)
def GetXY(self, event):
"""Wrapper around _getXY, which handles log scales"""
x,y = self._getXY(event)
if self.getLogScale()[0]:
x = _Numeric.power(10,x)
if self.getLogScale()[1]:
y = _Numeric.power(10,y)
return x,y
def GetXY(self,event): def _getXY(self,event):
"""Takes a mouse event and returns the XY user axis values.""" """Takes a mouse event and returns the XY user axis values."""
x,y= self.PositionScreenToUser(event.GetPosition()) x,y= self.PositionScreenToUser(event.GetPosition())
return x,y return x,y
@@ -840,6 +895,12 @@ class PlotCanvas(wx.Panel):
return self._ySpec return self._ySpec
def GetXMaxRange(self): def GetXMaxRange(self):
xAxis = self._getXMaxRange()
if self.getLogScale()[0]:
xAxis = _Numeric.power(10,xAxis)
return xAxis
def _getXMaxRange(self):
"""Returns (minX, maxX) x-axis range for displayed graph""" """Returns (minX, maxX) x-axis range for displayed graph"""
graphics= self.last_draw[0] graphics= self.last_draw[0]
p1, p2 = graphics.boundingBox() # min, max points of graphics p1, p2 = graphics.boundingBox() # min, max points of graphics
@@ -847,6 +908,12 @@ class PlotCanvas(wx.Panel):
return xAxis return xAxis
def GetYMaxRange(self): def GetYMaxRange(self):
yAxis = self._getYMaxRange()
if self.getLogScale()[1]:
yAxis = _Numeric.power(10,yAxis)
return yAxis
def _getYMaxRange(self):
"""Returns (minY, maxY) y-axis range for displayed graph""" """Returns (minY, maxY) y-axis range for displayed graph"""
graphics= self.last_draw[0] graphics= self.last_draw[0]
p1, p2 = graphics.boundingBox() # min, max points of graphics p1, p2 = graphics.boundingBox() # min, max points of graphics
@@ -854,35 +921,59 @@ class PlotCanvas(wx.Panel):
return yAxis return yAxis
def GetXCurrentRange(self): def GetXCurrentRange(self):
xAxis = self._getXCurrentRange()
if self.getLogScale()[0]:
xAxis = _Numeric.power(10,xAxis)
return xAxis
def _getXCurrentRange(self):
"""Returns (minX, maxX) x-axis for currently displayed portion of graph""" """Returns (minX, maxX) x-axis for currently displayed portion of graph"""
return self.last_draw[1] return self.last_draw[1]
def GetYCurrentRange(self): def GetYCurrentRange(self):
yAxis = self._getYCurrentRange()
if self.getLogScale()[1]:
yAxis = _Numeric.power(10,yAxis)
return yAxis
def _getYCurrentRange(self):
"""Returns (minY, maxY) y-axis for currently displayed portion of graph""" """Returns (minY, maxY) y-axis for currently displayed portion of graph"""
return self.last_draw[2] return self.last_draw[2]
def Draw(self, graphics, xAxis = None, yAxis = None, dc = None): def Draw(self, graphics, xAxis = None, yAxis = None, dc = None):
"""Draw objects in graphics with specified x and y axis. """Wrapper around _Draw, which handles log axes"""
graphics.setLogScale(self.getLogScale())
# check Axis is either tuple or none
if type(xAxis) not in [type(None),tuple]:
raise TypeError, "xAxis should be None or (minX,maxX)"+str(type(xAxis))
if type(yAxis) not in [type(None),tuple]:
raise TypeError, "yAxis should be None or (minY,maxY)"+str(type(xAxis))
# check case for axis = (a,b) where a==b caused by improper zooms
if xAxis != None:
if xAxis[0] == xAxis[1]:
return
if self.getLogScale()[0]:
xAxis = _Numeric.log10(xAxis)
if yAxis != None:
if yAxis[0] == yAxis[1]:
return
if self.getLogScale()[1]:
yAxis = _Numeric.log10(yAxis)
self._Draw(graphics, xAxis, yAxis, dc)
def _Draw(self, graphics, xAxis = None, yAxis = None, dc = None):
"""\
Draw objects in graphics with specified x and y axis.
graphics- instance of PlotGraphics with list of PolyXXX objects graphics- instance of PlotGraphics with list of PolyXXX objects
xAxis - tuple with (min, max) axis range to view xAxis - tuple with (min, max) axis range to view
yAxis - same as xAxis yAxis - same as xAxis
dc - drawing context - doesn't have to be specified. dc - drawing context - doesn't have to be specified.
If it's not, the offscreen buffer is used If it's not, the offscreen buffer is used
""" """
# check Axis is either tuple or none
if type(xAxis) not in [type(None),tuple]:
raise TypeError, "xAxis should be None or (minX,maxX)"
if type(yAxis) not in [type(None),tuple]:
raise TypeError, "yAxis should be None or (minY,maxY)"
# check case for axis = (a,b) where a==b caused by improper zooms
if xAxis != None:
if xAxis[0] == xAxis[1]:
return
if yAxis != None:
if yAxis[0] == yAxis[1]:
return
if dc == None: if dc == None:
# sets new dc and clears it # sets new dc and clears it
dc = wx.BufferedDC(wx.ClientDC(self.canvas), self._Buffer) dc = wx.BufferedDC(wx.ClientDC(self.canvas), self._Buffer)
@@ -910,21 +1001,24 @@ class PlotCanvas(wx.Panel):
p1= _Numeric.array([xAxis[0], yAxis[0]]) # lower left corner user scale (xmin,ymin) p1= _Numeric.array([xAxis[0], yAxis[0]]) # lower left corner user scale (xmin,ymin)
p2= _Numeric.array([xAxis[1], yAxis[1]]) # upper right corner user scale (xmax,ymax) p2= _Numeric.array([xAxis[1], yAxis[1]]) # upper right corner user scale (xmax,ymax)
self.last_draw = (graphics, xAxis, yAxis) # saves most recient values self.last_draw = (graphics, _Numeric.array(xAxis), _Numeric.array(yAxis)) # saves most recient values
# Get ticks and textExtents for axis if required # Get ticks and textExtents for axis if required
if self._xSpec is not 'none': if self._xSpec is not 'none':
xticks = self._ticks(xAxis[0], xAxis[1]) xticks = self._xticks(xAxis[0], xAxis[1])
xTextExtent = dc.GetTextExtent(xticks[-1][1])# w h of x axis text last number on axis xTextExtent = dc.GetTextExtent(xticks[-1][1])# w h of x axis text last number on axis
else: else:
xticks = None xticks = None
xTextExtent= (0,0) # No text for ticks xTextExtent= (0,0) # No text for ticks
if self._ySpec is not 'none': if self._ySpec is not 'none':
yticks = self._ticks(yAxis[0], yAxis[1]) yticks = self._yticks(yAxis[0], yAxis[1])
yTextExtentBottom= dc.GetTextExtent(yticks[0][1]) if self.getLogScale()[1]:
yTextExtentTop = dc.GetTextExtent(yticks[-1][1]) yTextExtent = dc.GetTextExtent('-2e-2')
yTextExtent= (max(yTextExtentBottom[0],yTextExtentTop[0]), else:
max(yTextExtentBottom[1],yTextExtentTop[1])) yTextExtentBottom = dc.GetTextExtent(yticks[0][1])
yTextExtentTop = dc.GetTextExtent(yticks[-1][1])
yTextExtent= (max(yTextExtentBottom[0],yTextExtentTop[0]),
max(yTextExtentBottom[1],yTextExtentTop[1]))
else: else:
yticks = None yticks = None
yTextExtent= (0,0) # No text for ticks yTextExtent= (0,0) # No text for ticks
@@ -981,13 +1075,14 @@ class PlotCanvas(wx.Panel):
# remove the clipping region # remove the clipping region
dc.DestroyClippingRegion() dc.DestroyClippingRegion()
dc.EndDrawing() dc.EndDrawing()
self._adjustScrollbars() self._adjustScrollbars()
def Redraw(self, dc= None): def Redraw(self, dc=None):
"""Redraw the existing plot.""" """Redraw the existing plot."""
if self.last_draw is not None: if self.last_draw is not None:
graphics, xAxis, yAxis= self.last_draw graphics, xAxis, yAxis= self.last_draw
self.Draw(graphics,xAxis,yAxis,dc) self._Draw(graphics,xAxis,yAxis,dc)
def Clear(self): def Clear(self):
"""Erase the window.""" """Erase the window."""
@@ -1009,7 +1104,7 @@ class PlotCanvas(wx.Panel):
h = (yAxis[1] - yAxis[0]) * Ratio[1] h = (yAxis[1] - yAxis[0]) * Ratio[1]
xAxis = ( x - w/2, x + w/2 ) xAxis = ( x - w/2, x + w/2 )
yAxis = ( y - h/2, y + h/2 ) yAxis = ( y - h/2, y + h/2 )
self.Draw(graphics, xAxis, yAxis) self._Draw(graphics, xAxis, yAxis)
def GetClosestPoints(self, pntXY, pointScaled= True): def GetClosestPoints(self, pntXY, pointScaled= True):
"""Returns list with """Returns list with
@@ -1070,7 +1165,7 @@ class PlotCanvas(wx.Panel):
""" """
if self.last_PointLabel != None: if self.last_PointLabel != None:
#compare pointXY #compare pointXY
if mDataDict["pointXY"] != self.last_PointLabel["pointXY"]: if _Numeric.sometrue(mDataDict["pointXY"] != self.last_PointLabel["pointXY"]):
#closest changed #closest changed
self._drawPointLabel(self.last_PointLabel) #erase old self._drawPointLabel(self.last_PointLabel) #erase old
self._drawPointLabel(mDataDict) #plot new self._drawPointLabel(mDataDict) #plot new
@@ -1087,7 +1182,7 @@ class PlotCanvas(wx.Panel):
self._drawRubberBand(self._zoomCorner1, self._zoomCorner2) # remove old self._drawRubberBand(self._zoomCorner1, self._zoomCorner2) # remove old
else: else:
self._hasDragged= True self._hasDragged= True
self._zoomCorner2[0], self._zoomCorner2[1] = self.GetXY(event) self._zoomCorner2[0], self._zoomCorner2[1] = self._getXY(event)
self._drawRubberBand(self._zoomCorner1, self._zoomCorner2) # add new self._drawRubberBand(self._zoomCorner1, self._zoomCorner2) # add new
elif self._dragEnabled and event.LeftIsDown(): elif self._dragEnabled and event.LeftIsDown():
coordinates = event.GetPosition() coordinates = event.GetPosition()
@@ -1095,11 +1190,14 @@ class PlotCanvas(wx.Panel):
dist = newpos-oldpos dist = newpos-oldpos
self._screenCoordinates = coordinates self._screenCoordinates = coordinates
self.ScrollUp(-dist[1]) if self.last_draw is not None:
self.ScrollRight(-dist[0]) graphics, xAxis, yAxis= self.last_draw
yAxis -= dist[1]
xAxis -= dist[0]
self._Draw(graphics,xAxis,yAxis)
def OnMouseLeftDown(self,event): def OnMouseLeftDown(self,event):
self._zoomCorner1[0], self._zoomCorner1[1]= self.GetXY(event) self._zoomCorner1[0], self._zoomCorner1[1]= self._getXY(event)
self._screenCoordinates = _Numeric.array(event.GetPosition()) self._screenCoordinates = _Numeric.array(event.GetPosition())
if self._dragEnabled: if self._dragEnabled:
self.SetCursor(self.GrabHandCursor) self.SetCursor(self.GrabHandCursor)
@@ -1109,16 +1207,16 @@ class PlotCanvas(wx.Panel):
if self._zoomEnabled: if self._zoomEnabled:
if self._hasDragged == True: if self._hasDragged == True:
self._drawRubberBand(self._zoomCorner1, self._zoomCorner2) # remove old self._drawRubberBand(self._zoomCorner1, self._zoomCorner2) # remove old
self._zoomCorner2[0], self._zoomCorner2[1]= self.GetXY(event) self._zoomCorner2[0], self._zoomCorner2[1]= self._getXY(event)
self._hasDragged = False # reset flag self._hasDragged = False # reset flag
minX, minY= _Numeric.minimum( self._zoomCorner1, self._zoomCorner2) minX, minY= _Numeric.minimum( self._zoomCorner1, self._zoomCorner2)
maxX, maxY= _Numeric.maximum( self._zoomCorner1, self._zoomCorner2) maxX, maxY= _Numeric.maximum( self._zoomCorner1, self._zoomCorner2)
self.last_PointLabel = None #reset pointLabel self.last_PointLabel = None #reset pointLabel
if self.last_draw != None: if self.last_draw != None:
self.Draw(self.last_draw[0], xAxis = (minX,maxX), yAxis = (minY,maxY), dc = None) self._Draw(self.last_draw[0], xAxis = (minX,maxX), yAxis = (minY,maxY), dc = None)
#else: # A box has not been drawn, zoom in on a point #else: # A box has not been drawn, zoom in on a point
## this interfered with the double click, so I've disables it. ## this interfered with the double click, so I've disables it.
# X,Y = self.GetXY(event) # X,Y = self._getXY(event)
# self.Zoom( (X,Y), (self._zoomInFactor,self._zoomInFactor) ) # self.Zoom( (X,Y), (self._zoomInFactor,self._zoomInFactor) )
if self._dragEnabled: if self._dragEnabled:
self.SetCursor(self.HandCursor) self.SetCursor(self.HandCursor)
@@ -1134,7 +1232,7 @@ class PlotCanvas(wx.Panel):
def OnMouseRightDown(self,event): def OnMouseRightDown(self,event):
if self._zoomEnabled: if self._zoomEnabled:
X,Y = self.GetXY(event) X,Y = self._getXY(event)
self.Zoom( (X,Y), (self._zoomOutFactor, self._zoomOutFactor) ) self.Zoom( (X,Y), (self._zoomOutFactor, self._zoomOutFactor) )
def OnPaint(self, event): def OnPaint(self, event):
@@ -1163,7 +1261,7 @@ class PlotCanvas(wx.Panel):
self.Clear() self.Clear()
else: else:
graphics, xSpec, ySpec = self.last_draw graphics, xSpec, ySpec = self.last_draw
self.Draw(graphics,xSpec,ySpec) self._Draw(graphics,xSpec,ySpec)
def OnLeave(self, event): def OnLeave(self, event):
"""Used to erase pointLabel when mouse outside window""" """Used to erase pointLabel when mouse outside window"""
@@ -1179,11 +1277,11 @@ class PlotCanvas(wx.Panel):
if evt.GetOrientation() == wx.VERTICAL: if evt.GetOrientation() == wx.VERTICAL:
fullrange,pagesize = self.sb_vert.GetRange(),self.sb_vert.GetPageSize() fullrange,pagesize = self.sb_vert.GetRange(),self.sb_vert.GetPageSize()
sbpos = fullrange-pagesize-sbpos sbpos = fullrange-pagesize-sbpos
dist = sbpos*self._sb_yunit-(self.GetYCurrentRange()[0]-self._sb_yfullrange[0]) dist = sbpos*self._sb_yunit-(self._getYCurrentRange()[0]-self._sb_yfullrange[0])
self.ScrollUp(dist) self.ScrollUp(dist)
if evt.GetOrientation() == wx.HORIZONTAL: if evt.GetOrientation() == wx.HORIZONTAL:
dist = sbpos*self._sb_xunit-(self.GetXCurrentRange()[0]-self._sb_xfullrange[0]) dist = sbpos*self._sb_xunit-(self._getXCurrentRange()[0]-self._sb_xfullrange[0])
self.ScrollRight(dist) self.ScrollRight(dist)
# Private Methods ************************************************** # Private Methods **************************************************
@@ -1207,7 +1305,7 @@ class PlotCanvas(wx.Panel):
"""Used for printing.""" """Used for printing."""
if self.last_draw != None: if self.last_draw != None:
graphics, xSpec, ySpec= self.last_draw graphics, xSpec, ySpec= self.last_draw
self.Draw(graphics,xSpec,ySpec,printDC) self._Draw(graphics,xSpec,ySpec,printDC)
def _drawPointLabel(self, mDataDict): def _drawPointLabel(self, mDataDict):
"""Draws and erases pointLabels""" """Draws and erases pointLabels"""
@@ -1410,6 +1508,49 @@ class PlotCanvas(wx.Panel):
pt[1]-0.5*h) pt[1]-0.5*h)
text = 0 # axis values not drawn on right side text = 0 # axis values not drawn on right side
def _xticks(self, *args):
if self._logscale[0]:
return self._logticks(*args)
else:
return self._ticks(*args)
def _yticks(self, *args):
if self._logscale[1]:
return self._logticks(*args)
else:
return self._ticks(*args)
def _logticks(self, lower, upper):
#lower,upper = map(_Numeric.log10,[lower,upper])
#print 'logticks',lower,upper
ticks = []
mag = _Numeric.power(10,_Numeric.floor(lower))
if upper-lower > 6:
t = _Numeric.power(10,_Numeric.ceil(lower))
base = _Numeric.power(10,_Numeric.floor((upper-lower)/6))
def inc(t):
return t*base-t
else:
t = _Numeric.ceil(_Numeric.power(10,lower)/mag)*mag
def inc(t):
return 10**int(_Numeric.floor(_Numeric.log10(t)+1e-16))
majortick = int(_Numeric.log10(mag))
while t <= pow(10,upper):
if majortick != int(_Numeric.floor(_Numeric.log10(t)+1e-16)):
majortick = int(_Numeric.floor(_Numeric.log10(t)+1e-16))
ticklabel = '1e%d'%majortick
else:
if upper-lower < 2:
minortick = int(t/pow(10,majortick)+.5)
ticklabel = '%de%d'%(minortick,majortick)
else:
ticklabel = ''
ticks.append((_Numeric.log10(t), ticklabel))
t += inc(t)
if len(ticks) == 0:
ticks = [(0,'')]
return ticks
def _ticks(self, lower, upper): def _ticks(self, lower, upper):
ideal = (upper-lower)/7. ideal = (upper-lower)/7.
log = _Numeric.log10(ideal) log = _Numeric.log10(ideal)
@@ -1450,8 +1591,8 @@ class PlotCanvas(wx.Panel):
needScrollbars = False needScrollbars = False
# horizontal scrollbar # horizontal scrollbar
r_current = self.GetXCurrentRange() r_current = self._getXCurrentRange()
r_max = list(self.GetXMaxRange()) r_max = list(self._getXMaxRange())
sbfullrange = float(self.sb_hor.GetRange()) sbfullrange = float(self.sb_hor.GetRange())
r_max[0] = min(r_max[0],r_current[0]) r_max[0] = min(r_max[0],r_current[0])
@@ -1472,8 +1613,8 @@ class PlotCanvas(wx.Panel):
self.sb_hor.SetScrollbar(0, 1000, 1000, 1000) self.sb_hor.SetScrollbar(0, 1000, 1000, 1000)
# vertical scrollbar # vertical scrollbar
r_current = self.GetYCurrentRange() r_current = self._getYCurrentRange()
r_max = list(self.GetYMaxRange()) r_max = list(self._getYMaxRange())
sbfullrange = float(self.sb_vert.GetRange()) sbfullrange = float(self.sb_vert.GetRange())
r_max[0] = min(r_max[0],r_current[0]) r_max[0] = min(r_max[0],r_current[0])
@@ -1746,6 +1887,16 @@ def _draw6Objects():
return PlotGraphics([line1, line1g, line1b, line2, line2g, line2b], return PlotGraphics([line1, line1g, line1b, line2, line2g, line2b],
"Bar Graph - (Turn on Grid, Legend)", "Months", "Number of Students") "Bar Graph - (Turn on Grid, Legend)", "Months", "Number of Students")
def _draw7Objects():
# Empty graph with axis defined but no points/lines
x = _Numeric.arange(1,1000,1)
y1 = 4.5*x**2
y2 = 2.2*x**3
points1 = _Numeric.transpose([x,y1])
points2 = _Numeric.transpose([x,y2])
line1 = PolyLine(points1, legend='quadratic', colour='blue', width=1)
line2 = PolyLine(points2, legend='cubic', colour='red', width=1)
return PlotGraphics([line1,line2], "double log plot", "Value X", "Value Y")
class TestFrame(wx.Frame): class TestFrame(wx.Frame):
@@ -1786,7 +1937,8 @@ class TestFrame(wx.Frame):
self.Bind(wx.EVT_MENU,self.OnPlotDraw5, id=210) self.Bind(wx.EVT_MENU,self.OnPlotDraw5, id=210)
menu.Append(260, 'Draw6', 'Draw plots6') menu.Append(260, 'Draw6', 'Draw plots6')
self.Bind(wx.EVT_MENU,self.OnPlotDraw6, id=260) self.Bind(wx.EVT_MENU,self.OnPlotDraw6, id=260)
menu.Append(261, 'Draw7', 'Draw plots7')
self.Bind(wx.EVT_MENU,self.OnPlotDraw7, id=261)
menu.Append(211, '&Redraw', 'Redraw plots') menu.Append(211, '&Redraw', 'Redraw plots')
self.Bind(wx.EVT_MENU,self.OnPlotRedraw, id=211) self.Bind(wx.EVT_MENU,self.OnPlotRedraw, id=211)
@@ -1828,12 +1980,11 @@ class TestFrame(wx.Frame):
#define the function for drawing pointLabels #define the function for drawing pointLabels
self.client.SetPointLabelFunc(self.DrawPointLabel) self.client.SetPointLabelFunc(self.DrawPointLabel)
# Create mouse event for showing cursor coords in status bar # Create mouse event for showing cursor coords in status bar
self.client.Bind(wx.EVT_LEFT_DOWN, self.OnMouseLeftDown) self.client.canvas.Bind(wx.EVT_LEFT_DOWN, self.OnMouseLeftDown)
# Show closest point when enabled # Show closest point when enabled
self.client.Bind(wx.EVT_MOTION, self.OnMotion) self.client.canvas.Bind(wx.EVT_MOTION, self.OnMotion)
self.Show()
self.Show(True)
def DrawPointLabel(self, dc, mDataDict): def DrawPointLabel(self, dc, mDataDict):
"""This is the fuction that defines how the pointLabels are plotted """This is the fuction that defines how the pointLabels are plotted
@@ -1860,7 +2011,7 @@ class TestFrame(wx.Frame):
# ----------- # -----------
def OnMouseLeftDown(self,event): def OnMouseLeftDown(self,event):
s= "Left Mouse Down at Point: (%.4f, %.4f)" % self.client.GetXY(event) s= "Left Mouse Down at Point: (%.4f, %.4f)" % self.client._getXY(event)
self.SetStatusText(s) self.SetStatusText(s)
event.Skip() #allows plotCanvas OnMouseLeftDown to be called event.Skip() #allows plotCanvas OnMouseLeftDown to be called
@@ -1869,7 +2020,7 @@ class TestFrame(wx.Frame):
if self.client.GetEnablePointLabel() == True: if self.client.GetEnablePointLabel() == True:
#make up dict with info for the pointLabel #make up dict with info for the pointLabel
#I've decided to mark the closest point on the closest curve #I've decided to mark the closest point on the closest curve
dlst= self.client.GetClosetPoint( self.client.GetXY(event), pointScaled= True) dlst= self.client.GetClosetPoint( self.client._getXY(event), pointScaled= True)
if dlst != []: #returns [] if none if dlst != []: #returns [] if none
curveNum, legend, pIndex, pointXY, scaledXY, distance = dlst curveNum, legend, pIndex, pointXY, scaledXY, distance = dlst
#make up dictionary to pass to my user function (see DrawPointLabel) #make up dictionary to pass to my user function (see DrawPointLabel)
@@ -1939,6 +2090,12 @@ class TestFrame(wx.Frame):
self.client.SetYSpec('auto') self.client.SetYSpec('auto')
self.client.Draw(_draw6Objects(), xAxis= (0,7)) self.client.Draw(_draw6Objects(), xAxis= (0,7))
def OnPlotDraw7(self, event):
#log scale example
self.resetDefaults()
self.client.setLogScale((True,True))
self.client.Draw(_draw7Objects())
def OnPlotRedraw(self,event): def OnPlotRedraw(self,event):
self.client.Redraw() self.client.Redraw()
@@ -1986,9 +2143,11 @@ class TestFrame(wx.Frame):
self.client.SetFont(wx.Font(10,wx.SWISS,wx.NORMAL,wx.NORMAL)) self.client.SetFont(wx.Font(10,wx.SWISS,wx.NORMAL,wx.NORMAL))
self.client.SetFontSizeAxis(10) self.client.SetFontSizeAxis(10)
self.client.SetFontSizeLegend(7) self.client.SetFontSizeLegend(7)
self.client.setLogScale((False,False))
self.client.SetXSpec('auto') self.client.SetXSpec('auto')
self.client.SetYSpec('auto') self.client.SetYSpec('auto')
def __test(): def __test():

70
wxPython/wx/lib/pubsub.py
View File

@@ -604,10 +604,11 @@ class PublisherClass:
- message: this is an instance of Message, containing the topic for - message: this is an instance of Message, containing the topic for
which the message was sent, and any data the sender specified. which the message was sent, and any data the sender specified.
:note: This class is visible to importers of pubsub only as a :note: This class is visible to importers of pubsub only as a
Singleton. I.e., every time you execute 'Publisher()', it's Singleton. I.e., every time you execute 'Publisher()', it's
actually the same instance of PublisherClass that is returned. So to actually the same instance of PublisherClass that is
use, just do 'Publisher().method()'. returned. So to use, just do'Publisher().method()'.
""" """
__ALL_TOPICS_TPL = (ALL_TOPICS, ) __ALL_TOPICS_TPL = (ALL_TOPICS, )
@@ -645,31 +646,33 @@ class PublisherClass:
listener. See the class doc for requirements on listener and listener. See the class doc for requirements on listener and
topic. topic.
:note: The listener is held by Publisher() only by *weak* reference. :note: The listener is held by Publisher() only by *weak*
This means you must ensure you have at least one strong reference reference. This means you must ensure you have at
to listener, otherwise it will be DOA ("dead on arrival"). This is least one strong reference to listener, otherwise it
particularly easy to forget when wrapping a listener method in a will be DOA ("dead on arrival"). This is particularly
proxy object (e.g. to bind some of its parameters), e.g. easy to forget when wrapping a listener method in a
proxy object (e.g. to bind some of its parameters),
e.g.::
:code: class Foo:
class Foo: def listener(self, event): pass
def listener(self, event): pass class Wrapper:
class Wrapper: def __init__(self, fun): self.fun = fun
def __init__(self, fun): self.fun = fun def __call__(self, *args): self.fun(*args)
def __call__(self, *args): self.fun(*args) foo = Foo()
foo = Foo() Publisher().subscribe( Wrapper(foo.listener) ) # whoops: DOA!
Publisher().subscribe( Wrapper(foo.listener) ) # whoops: DOA! wrapper = Wrapper(foo.listener)
wrapper = Wrapper(foo.listener) Publisher().subscribe(wrapper) # good!
Publisher().subscribe(wrapper) # good!
:note: Calling this method for the same listener, with two
topics in the same branch of the topic hierarchy, will
cause the listener to be notified twice when a message
for the deepest topic is sent. E.g.
subscribe(listener, 't1') and then subscribe(listener,
('t1','t2')) means that when calling sendMessage('t1'),
listener gets one message, but when calling
sendMessage(('t1','t2')), listener gets message twice.
:note: Calling
this method for the same listener, with two topics in the same
branch of the topic hierarchy, will cause the listener to be
notified twice when a message for the deepest topic is sent. E.g.
subscribe(listener, 't1') and then subscribe(listener, ('t1','t2'))
means that when calling sendMessage('t1'), listener gets one message,
but when calling sendMessage(('t1','t2')), listener gets message
twice.
""" """
self.validate(listener) self.validate(listener)
@@ -765,13 +768,14 @@ class PublisherClass:
"""Return a list of topics the given listener is registered with. """Return a list of topics the given listener is registered with.
Returns [] if listener never subscribed. Returns [] if listener never subscribed.
:attention: when using the return of this method to compare to :attention: when using the return of this method to compare to
expected list of topics, remember that topics that are not in the expected list of topics, remember that topics that are
form of a tuple appear as a one-tuple in the return. E.g. if you not in the form of a tuple appear as a one-tuple in
have subscribed a listener to 'topic1' and ('topic2','subtopic2'), the return. E.g. if you have subscribed a listener to
this method returns:: 'topic1' and ('topic2','subtopic2'), this method
returns::
associatedTopics = [('topic1',), ('topic2','subtopic2')] associatedTopics = [('topic1',), ('topic2','subtopic2')]
""" """
return self.__topicTree.getTopics(listener) return self.__topicTree.getTopics(listener)

9
wxPython/wx/lib/sheet.py
View File

@@ -64,8 +64,9 @@ class CCellEditor(wx.grid.PyGridCellEditor):
def Show(self, show, attr): def Show(self, show, attr):
""" Show or hide the edit control. Use the attr (if not None) """ Show or hide the edit control. Use the attr (if not None)
to set colors or fonts for the control. to set colors or fonts for the control.
NOTE: There is no need to everride this if you don't need NOTE: There is no need to everride this if you don't need
to do something out of the ordinary. to do something out of the ordinary.
""" """
super(CCellEditor, self).Show(show, attr) super(CCellEditor, self).Show(show, attr)
@@ -73,8 +74,9 @@ class CCellEditor(wx.grid.PyGridCellEditor):
""" Draws the part of the cell not occupied by the edit control. The """ Draws the part of the cell not occupied by the edit control. The
base class version just fills it with background colour from the base class version just fills it with background colour from the
attribute. attribute.
NOTE: There is no need to everride this if you don't need NOTE: There is no need to everride this if you don't need
to do something out of the ordinary. to do something out of the ordinary.
""" """
# Call base class method. # Call base class method.
super(CCellEditor, self).PaintBackground(self, rect, attr) super(CCellEditor, self).PaintBackground(self, rect, attr)
@@ -151,8 +153,9 @@ class CCellEditor(wx.grid.PyGridCellEditor):
def Destroy(self): def Destroy(self):
""" Final cleanup """ Final cleanup
NOTE: There is no need to everride this if you don't need NOTE: There is no need to everride this if you don't need
to do something out of the ordinary. to do something out of the ordinary.
""" """
super(CCellEditor, self).Destroy() super(CCellEditor, self).Destroy()

16
wxPython/wx/lib/ticker.py
View File

@@ -12,12 +12,16 @@
"""News-ticker style scrolling text control """News-ticker style scrolling text control
Can scroll from right to left or left to right. * Can scroll from right to left or left to right.
Speed of the ticking is controlled by two parameters:
Frames per Second(FPS): How many times per second the ticker updates * Speed of the ticking is controlled by two parameters:
Pixels per Frame(PPF): How many pixels the text moves each update
Low FPS with high PPF will result in "jumpy" text, lower PPF with higher FPS - Frames per Second(FPS): How many times per second the ticker updates
is smoother (but blurrier and more CPU intensive) text.
- Pixels per Frame(PPF): How many pixels the text moves each update
Low FPS with high PPF will result in "jumpy" text, lower PPF with higher FPS
is smoother (but blurrier and more CPU intensive) text.
""" """
import wx import wx

6
wxPython/wx/lib/wxpTag.py
View File

@@ -25,7 +25,7 @@ You don\'t need to use anything in this module directly, just
importing it will create the tag handler and add it to any importing it will create the tag handler and add it to any
wxHtmlWinParsers created from that time forth. wxHtmlWinParsers created from that time forth.
Tags of the following form are recognised: Tags of the following form are recognised::
<WXP class="classname" [module="modulename"] [width="num"] [height="num"]> <WXP class="classname" [module="modulename"] [width="num"] [height="num"]>
<PARAM name="parameterName" value="parameterValue> <PARAM name="parameterName" value="parameterValue>
@@ -46,7 +46,7 @@ The name-value pairs in all the nested PARAM tags are packaged up as
strings into a python dictionary and passed to the __init__ method of strings into a python dictionary and passed to the __init__ method of
the class as keyword arguments. This means that they are all the class as keyword arguments. This means that they are all
accessible from the __init__ method as regular parameters, or you use accessible from the __init__ method as regular parameters, or you use
the special Python **kw syntax in your __init__ method to get the the special Python \*\*kw syntax in your __init__ method to get the
dictionary directly. dictionary directly.
Some parameter values are special and if they are present then they will Some parameter values are special and if they are present then they will
@@ -71,7 +71,7 @@ be converted from strings to alternate datatypes. They are:
object and if it fails then the original string value object and if it fails then the original string value
will be used instead. will be used instead.
An example: An example::
<wxp module="wx" class="Button"> <wxp module="wx" class="Button">
<param name="label" value="Click here"> <param name="label" value="Click here">

20
wxPython/wx/py/dispatcher.py
View File

@@ -32,16 +32,18 @@ _boundMethods = weakref.WeakKeyDictionary()
def connect(receiver, signal=Any, sender=Any, weak=True): def connect(receiver, signal=Any, sender=Any, weak=True):
"""Connect receiver to sender for signal. """
Connect receiver to sender for signal.
If sender is Any, receiver will receive signal from any sender. * If sender is Any, receiver will receive signal from any sender.
If signal is Any, receiver will receive any signal from sender. * If signal is Any, receiver will receive any signal from sender.
If sender is None, receiver will receive signal from Anonymous. * If sender is None, receiver will receive signal from Anonymous.
If signal is Any and sender is None, receiver will receive any * If signal is Any and sender is None, receiver will receive any
signal from Anonymous. signal from Anonymous.
If signal is Any and sender is Any, receiver will receive any * If signal is Any and sender is Any, receiver will receive any
signal from any sender. signal from any sender.
If weak is true, weak references will be used.""" * If weak is true, weak references will be used.
"""
if signal is None: if signal is None:
raise DispatcherError, 'signal cannot be None' raise DispatcherError, 'signal cannot be None'
if weak: if weak:

2
wxPython/wx/py/shell.py
View File

@@ -354,7 +354,7 @@ class Shell(editwindow.EditWindow):
def setBuiltinKeywords(self): def setBuiltinKeywords(self):
"""Create pseudo keywords as part of builtins. """Create pseudo keywords as part of builtins.
This sets `close`, `exit` and `quit` to a helpful string. This sets "close", "exit" and "quit" to a helpful string.
""" """
import __builtin__ import __builtin__
__builtin__.close = __builtin__.exit = __builtin__.quit = \ __builtin__.close = __builtin__.exit = __builtin__.quit = \

3
wxPython/wx/tools/dbg.py
View File

@@ -75,7 +75,8 @@ stream
changing it will result in no action being taken. changing it will result in no action being taken.
You can also call the log function implicitly on the Logger You can also call the log function implicitly on the Logger
instance, ie. you can type: instance, ie. you can type::
from wxPython.tools.dbg import Logger from wxPython.tools.dbg import Logger
dbg = Logger() dbg = Logger()
dbg('something to print') dbg('something to print')