some tweaks to image size and backend docs

jdh2358 · jdh2358 · commit 7402853d87cf · 2008-06-10T22:49:02.000Z
svn path=/trunk/matplotlib/; revision=5465
diff --git a/doc/devel/outline.rst b/doc/devel/outline.rst
@@ -103,20 +103,20 @@ If you want to make notes for the authorwhen you have reviewed a
 submission, you can put them here.  As the author cleans them up or
 addresses them, they should be removed.
 
-mathtext user's guide-- reviewd by JDH
---------------------------------------
+mathtext user's guide-- reviewed by JDH
+---------------------------------------
 
 This looks good (see :ref:`mathtext-tutorial`) -- there are a few
-minor things to close the book on this chapter.
+minor things to close the book on this chapter:
 
 #. The main thing to wrap this up is getting the mathtext module
-ported over to rest and included in the API so the links from the
-user's guide tutorial work.
+    ported over to rest and included in the API so the links from the
+    user's guide tutorial work.
 
 #. This section might also benefit from a little more detail on the
-customizations that are possible (eg an example fleshing out the rc
-options a little bit).  Admittedly, this is pretty clear from readin
-ghte rc file, but it might be helpful to a newbie.
+   customizations that are possible (eg an example fleshing out the rc
+   options a little bit).  Admittedly, this is pretty clear from
+   readin ghte rc file, but it might be helpful to a newbie.
 
 #. There is still a TODO in the file to include a complete list of symbols
 
diff --git a/doc/users/annotations.rst b/doc/users/annotations.rst
@@ -15,7 +15,7 @@ arguments are ``(x,y)`` tuples.
 .. literalinclude:: figures/annotation_basic.py
 
 .. image:: figures/annotation_basic.png
-   :scale: 50
+   :scale: 75
 
 In this example, both the ``xy`` (arrow tip) and ``xytext`` locations
 (text location) are in data coordinates.  There are a variety of other
@@ -76,7 +76,7 @@ keyword args like ``horizontalalignment``, ``verticalalignment`` and
 .. literalinclude:: figures/annotation_polar.py
 
 .. image:: figures/annotation_polar.png
-   :scale: 50
+   :scale: 75
 
 See the `annotations demo
 <http://matplotlib.sf.net/examples/pylab_examples/annotation_demo.py>`_ for more
diff --git a/doc/users/event_handling.rst b/doc/users/event_handling.rst
@@ -70,15 +70,17 @@ Event attributes
 ================
 
 All matplotlib events inherit from the base class
-:class:`matplotlib.backend_bases.Event`, which store the attributes
+:class:`matplotlib.backend_bases.Event`, which store the attributes:
+
+    ``name``
+	the event name
+
+    ``canvas``
+	the FigureCanvas instance generating the event
+
+    ``guiEvent``
+	the GUI event that triggered the matplotlib event
 
-===============  =================================================
-Event attribute  Description
-===============  =================================================
-``name``         the event name
-``canvas``       the FigureCanvas instance generating the event
-``guiEvent``     the GUI event that triggered the matplotlib event
-===============  =================================================
 
 The most common events that are the bread and butter of event handling
 are key press/release events and mouse press/release and movement
@@ -87,16 +89,20 @@ events.  The :class:`~matplotlib.backend_bases.KeyEvent` and
 these events are both derived from the LocationEvent, which has the
 following attributes
 
-=======================   ========================================
-LocationEvent attribute   Description
-=======================   ========================================
-``x``                     x position - pixels from left of canvas
-``y``                     y position - pixels from right of canvas
-``button``                button pressed None, 1, 2, 3
-``inaxes``                the Axes instance if mouse us over axes
-``xdata``                 x coord of mouse in data coords
-``ydata``                 y coord of mouse in data coords
-=======================   ========================================
+    ``x``
+        x position - pixels from left of canvas
+
+    ``y``
+        y position - pixels from bottom of canvas
+
+    ``inaxes``
+        the :class:`~matplotlib.axes.Axes` instance if mouse is over axes
+
+    ``xdata``
+        x coord of mouse in data coords
+
+    ``ydata``
+        y coord of mouse in data coords
 
 Let's look a simple example of a canvas, where a simple line segment
 is created every time a mouse is pressed::
@@ -129,12 +135,11 @@ The :class:`~matplotlib.backend_bases.MouseEvent` that we just used is a
 the data and pixel coordinates in event.x and event.xdata.  In
 addition to the ``LocationEvent`` attributes, it has
 
-====================   ==============================================================
-MouseEvent attribute   Description
-====================   ==============================================================
-``button``             button pressed None, 1, 2, 3
-``key``                the key pressed: None, chr(range(255)), shift, win, or control
-====================   ==============================================================
+    ``button``
+        button pressed None, 1, 2, 3, 'up', 'down' (up and down are used for scroll events)
+
+    ``key``
+        the key pressed: None, chr(range(255), 'shift', 'win', or 'control'
 
 Draggable Rectangle Exercise
 ----------------------------
@@ -281,7 +286,6 @@ Extra credit solution::
             self.rect.set_x(x0+dx)
             self.rect.set_y(y0+dy)
 
-
             canvas = self.rect.figure.canvas
             axes = self.rect.axes
             # restore the background region
@@ -293,8 +297,6 @@ Extra credit solution::
             # blit just the redrawn area
             canvas.blit(axes.bbox)
 
-
-
         def on_release(self, event):
             'on release we reset the press data'
             if DraggableRectangle.lock is not self:
@@ -309,6 +311,7 @@ Extra credit solution::
 
             # redraw the full figure
             self.rect.figure.canvas.draw()
+
         def disconnect(self):
             'disconnect all the stored connection ids'
             self.rect.figure.canvas.mpl_disconnect(self.cidpress)
@@ -340,24 +343,29 @@ You can enable picking by setting the ``picker`` property of an
 
 There are a variety of meanings of the ``picker`` property:
 
-- ``None`` :  picking is disabled for this artist (default)
+    ``None``
+	picking is disabled for this artist (default)
 
-- ``boolean`` : if True then picking will be enabled and the artist will
-  fire a pick event if the mouse event is over the artist
+    ``boolean``
+	if True then picking will be enabled and the artist will fire a
+	pick event if the mouse event is over the artist
 
-- ``float`` : if picker is a number it is interpreted as an epsilon
-  tolerance in points and the the artist will fire off an event if its
-  data is within epsilon of the mouse event.  For some artists like
-  lines and patch collections, the artist may provide additional data
-  to the pick event that is generated, eg the indices of the data
-  within epsilon of the pick event.
+    ``float``
+	if picker is a number it is interpreted as an epsilon tolerance in
+	points and the the artist will fire off an event if its data is
+	within epsilon of the mouse event.  For some artists like lines
+	and patch collections, the artist may provide additional data to
+	the pick event that is generated, eg the indices of the data
+	within epsilon of the pick event.
 
-- ``function`` : if picker is callable, it is a user supplied function
-  which determines whether the artist is hit by the mouse event.  The
-  signature is ``hit, props = picker(artist, mouseevent)`` to
-  determine the hit test.  If the mouse event is over the artist,
-  return ``hit=True`` and props is a dictionary of properties you want
-  added to the :class:`~matplotlib.backend_bases.PickEvent` attributes
+    ``function``
+	if picker is callable, it is a user supplied function which
+	determines whether the artist is hit by the mouse event.  The
+	signature is ``hit, props = picker(artist, mouseevent)`` to
+	determine the hit test.  If the mouse event is over the artist,
+	return ``hit=True`` and props is a dictionary of properties you
+	want added to the :class:`~matplotlib.backend_bases.PickEvent`
+	attributes
 
 
 After you have enabled an artist for picking by setting the ``picker``
@@ -373,16 +381,18 @@ pick callbacks on mouse press events.  Eg::
 The :class:`~matplotlib.backend_bases.PickEvent` which is passed to
 your callback is always fired with two attributes:
 
-- ``mouseevent`` : the mouse event that generate the pick event.  The
-  mouse event in turn has attributes like ``x`` and ``y`` (the coords in
-  display space, eg pixels from left, bottom) and xdata, ydata (the
-  coords in data space).  Additionally, you can get information about
-  which buttons were pressed, which keys were pressed, which Axes the
-  mouse is over, etc.  See :class:`matplotlib.backend_bases.MouseEvent` for
-  details.
-
-- ``artist`` : the :class:`matplotlib.artist.Artist` that generated
-  the pick event.
+    ``mouseevent`` the mouse event that generate the pick event.  The
+	mouse event in turn has attributes like ``x`` and ``y`` (the
+	coords in display space, eg pixels from left, bottom) and xdata,
+	ydata (the coords in data space).  Additionally, you can get
+	information about which buttons were pressed, which keys were
+	pressed, which :class:`~matplotlib.axes.Axes` the mouse is over,
+	etc.  See :class:`matplotlib.backend_bases.MouseEvent` for
+	details.
+
+    ``artist``
+	the :class:`~matplotlib.artist.Artist` that generated the pick
+	event.
 
 Additionally, certain artists like :class:`~matplotlib.lines.Line2D`
 and :class:`~matplotlib.collections.PatchCollection` may attach
diff --git a/doc/users/figures/make.py b/doc/users/figures/make.py
@@ -2,7 +2,7 @@
 import sys, os, glob
 import matplotlib
 import IPython.Shell
-matplotlib.rcdefaults()
+#matplotlib.rcdefaults()
 matplotlib.use('Agg')
 
 mplshell = IPython.Shell.MatplotlibShell('mpl')
diff --git a/doc/users/figures/pyplot_simple.py b/doc/users/figures/pyplot_simple.py
@@ -1,4 +1,4 @@
 import matplotlib.pyplot as plt
 plt.plot([1,2,3])
 plt.ylabel('some numbers')
-
+plt.show()
diff --git a/doc/users/mathtext.rst b/doc/users/mathtext.rst
@@ -233,7 +233,7 @@ Here is an example illustrating many of these features in context.
 .. literalinclude:: figures/pyplot_mathtext.py
 
 .. image:: figures/pyplot_mathtext.png
-   :scale: 50
+   :scale: 75
 
 
 
diff --git a/doc/users/pyplot_tutorial.rst b/doc/users/pyplot_tutorial.rst
@@ -4,18 +4,18 @@
 pyplot tutorial
 ***************
 
-:mod:`matplotlib.pyplot` is a collection of functions that make
-matplotlib work like matlab.  Each ``pyplot`` function makes some
-change to a figure: eg, create a figure, create a plotting area in a
-figure, plot some lines in a plotting area, decorate the plot with
-labels, etc....  :mod:`matplotlib.pyplot` is stateful, in that it
+:mod:`matplotlib.pyplot` is a collection of command style functions
+that make matplotlib work like matlab.  Each ``pyplot`` function makes
+some change to a figure: eg, create a figure, create a plotting area
+in a figure, plot some lines in a plotting area, decorate the plot
+with labels, etc....  :mod:`matplotlib.pyplot` is stateful, in that it
 keeps track of the current figure and plotting area, and the plotting
 functions are directed to the current axes
 
 .. literalinclude:: figures/pyplot_simple.py
 
 .. image:: figures/pyplot_simple.png
-   :scale: 50
+   :scale: 75
 
 
 You may be wondering why the x-axis ranges from 0-3 and the y-axis
@@ -42,7 +42,7 @@ example, to plot the above with red circles, you would issue
 .. literalinclude:: figures/pyplot_formatstr.py
 
 .. image:: figures/pyplot_formatstr.png
-   :scale: 50
+   :scale: 75
 
 See the :func:`~matplotlib.pyplot.plot` documentation for a complete
 list of line styles and format strings.  The
@@ -60,9 +60,7 @@ using arrays.
 .. literalinclude:: figures/pyplot_three.py
 
 .. image:: figures/pyplot_three.png
-   :scale: 50
-
-
+   :scale: 75
 
 .. _controlling-line-properties:
 
@@ -169,7 +167,7 @@ scenes.  Below is an script to create two subplots.
 .. literalinclude:: figures/pyplot_two_subplots.py
 
 .. image:: figures/pyplot_two_subplots.png
-   :scale: 50
+   :scale: 75
 
 The :func:`~matplotlib.pyplot.figure` command here is optional because
 ``figure(1)`` will be created by default, just as a ``subplot(111)``
@@ -230,7 +228,7 @@ for a more detailed example)
 .. literalinclude:: figures/pyplot_text.py
 
 .. image:: figures/pyplot_text.png
-   :scale: 50
+   :scale: 75
 
 
 All of the :func:`~matplotlib.pyplot.text` commands return an
@@ -278,7 +276,7 @@ these arguments are ``(x,y)`` tuples.
 .. literalinclude:: figures/pyplot_annotate.py
 
 .. image:: figures/pyplot_annotate.png
-   :scale: 50
+   :scale: 75
 
 In this basic example, both the ``xy`` (arrow tip) and ``xytext``
 locations (text location) are in data coordinates.  There are a
diff --git a/doc/users/text_intro.rst b/doc/users/text_intro.rst
@@ -58,5 +58,5 @@ these commands in action.
 .. literalinclude:: figures/text_commands.py
 
 .. image:: figures/text_commands.png
-   :scale: 50
+   :scale: 75
 
diff --git a/doc/users/text_props.rst b/doc/users/text_props.rst
@@ -60,4 +60,4 @@ upper right.
 .. literalinclude:: figures/text_layout.py
 
 .. image:: figures/text_layout.png
-   :scale: 50
+   :scale: 75
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -640,6 +640,10 @@ class Event:
     ``canvas``
         the FigureCanvas instance generating the event
 
+    ``guiEvent``
+        the GUI event that triggered the matplotlib event
+
+
     """
     def __init__(self, name, canvas,guiEvent=None):
         self.name = name
diff --git a/lib/matplotlib/backends/backend_template.py b/lib/matplotlib/backends/backend_template.py
@@ -1,4 +1,4 @@
-"""
+M"""
 This is a fully functional do nothing backend to provide a template to
 backend writers.  It is fully functional in that you can select it as
 a backend with
