<?xml version="1.0" encoding="ascii"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>wxmpl.PlotFrame</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="wxmpl-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" >WxMpl</th> </tr></table></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="wxmpl-module.html">Module wxmpl</a> :: Class PlotFrame </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="wxmpl.PlotFrame-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class PlotFrame</h1><p class="nomargin-top"><span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame">source code</a></span></p> <pre class="base-tree"> wx.Frame --+ | <strong class="uidshort">PlotFrame</strong> </pre> <hr /> <p>A matplotlib canvas embedded in a wxPython top-level window.</p> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Instance Methods</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="wxmpl.PlotFrame-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">parent</span>, <span class="summary-sig-arg">id</span>, <span class="summary-sig-arg">title</span>, <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">(6.0,3.7)</span>, <span class="summary-sig-arg">dpi</span>=<span class="summary-sig-default">96</span>, <span class="summary-sig-arg">cursor</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">location</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">crosshairs</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">selection</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">zoom</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">autoscaleUnzoom</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">**kwds</span>)</span><br /> Creates a new PlotFrame top-level window that is the child of the wxPython window <code>parent</code> with the wxPython identifier <code>id</code> and the title of <code>title</code>.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="create_menus"></a><span class="summary-sig-name">create_menus</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.create_menus">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnMenuFileSave"></a><span class="summary-sig-name">OnMenuFileSave</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Handles File->Save menu events.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.OnMenuFileSave">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnMenuFilePageSetup"></a><span class="summary-sig-name">OnMenuFilePageSetup</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Handles File->Page Setup menu events</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.OnMenuFilePageSetup">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnMenuFilePrintPreview"></a><span class="summary-sig-name">OnMenuFilePrintPreview</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Handles File->Print Preview menu events</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.OnMenuFilePrintPreview">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnMenuFilePrint"></a><span class="summary-sig-name">OnMenuFilePrint</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Handles File->Print menu events</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.OnMenuFilePrint">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnMenuFileClose"></a><span class="summary-sig-name">OnMenuFileClose</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Handles File->Close menu events.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.OnMenuFileClose">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="OnMenuHelpAbout"></a><span class="summary-sig-name">OnMenuHelpAbout</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">evt</span>)</span><br /> Handles Help->About menu events.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.OnMenuHelpAbout">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="get_figure"></a><span class="summary-sig-name">get_figure</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the figure associated with this canvas.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.get_figure">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="wxmpl.PlotFrame-class.html#set_cursor" class="summary-sig-name">set_cursor</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable the changing mouse cursor.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.set_cursor">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_location"></a><span class="summary-sig-name">set_location</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable the display of the matplotlib axes coordinates of the mouse in the lower left corner of the canvas.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.set_location">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_crosshairs"></a><span class="summary-sig-name">set_crosshairs</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable drawing crosshairs through the mouse cursor when it is inside a matplotlib axes.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.set_crosshairs">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_selection"></a><span class="summary-sig-name">set_selection</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable area selections, where user selects a rectangular area of the canvas by left-clicking and dragging the mouse.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.set_selection">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_zoom"></a><span class="summary-sig-name">set_zoom</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable zooming in when the user makes an area selection and zooming out again when the user right-clicks.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.set_zoom">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="set_autoscale_unzoom"></a><span class="summary-sig-name">set_autoscale_unzoom</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span><br /> Enable or disable automatic view rescaling when the user zooms out to the initial figure.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.set_autoscale_unzoom">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="draw"></a><span class="summary-sig-name">draw</span>(<span class="summary-sig-arg">self</span>)</span><br /> Draw the associated <code>Figure</code> onto the screen.</td> <td align="right" valign="top"> <span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.draw">source code</a></span> </td> </tr> </table> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Class Variables</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="ABOUT_TITLE"></a><span class="summary-name">ABOUT_TITLE</span> = <code title="'About wxmpl.PlotFrame'">'About wxmpl.PlotFrame'</code><br /> Title of the "About" dialog. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="wxmpl.PlotFrame-class.html#ABOUT_MESSAGE" class="summary-name">ABOUT_MESSAGE</a> = <code title="'wxmpl.PlotFrame %s\n' % __version__+ 'Written by Ken McIvor <mcivor@i\ it.edu>\n'+ 'Copyright 2005-2009 Illinois Institute of Technology'">'wxmpl.PlotFrame %s\n' % __version__+ 'Written<code class="variable-ellipsis">...</code></code><br /> Contents of the "About" dialog. </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Method Details</span></td> </tr> </table> <a name="__init__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">parent</span>, <span class="sig-arg">id</span>, <span class="sig-arg">title</span>, <span class="sig-arg">size</span>=<span class="sig-default">(6.0,3.7)</span>, <span class="sig-arg">dpi</span>=<span class="sig-default">96</span>, <span class="sig-arg">cursor</span>=<span class="sig-default">True</span>, <span class="sig-arg">location</span>=<span class="sig-default">True</span>, <span class="sig-arg">crosshairs</span>=<span class="sig-default">True</span>, <span class="sig-arg">selection</span>=<span class="sig-default">True</span>, <span class="sig-arg">zoom</span>=<span class="sig-default">True</span>, <span class="sig-arg">autoscaleUnzoom</span>=<span class="sig-default">True</span>, <span class="sig-arg">**kwds</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.__init__">source code</a></span> </td> </tr></table> <p>Creates a new PlotFrame top-level window that is the child of the wxPython window <code>parent</code> with the wxPython identifier <code>id</code> and the title of <code>title</code>.</p> <p>All of the named keyword arguments to this constructor have the same meaning as those arguments to the constructor of <code>PlotPanel</code>.</p> <p>Any additional keyword arguments are passed to the constructor of <code>wx.Frame</code>.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="set_cursor"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">set_cursor</span>(<span class="sig-arg">self</span>, <span class="sig-arg">state</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="wxmpl-pysrc.html#PlotFrame.set_cursor">source code</a></span> </td> </tr></table> <p>Enable or disable the changing mouse cursor. When enabled, the cursor changes from the normal arrow to a square cross when the mouse enters a matplotlib axes on this canvas.</p> <dl class="fields"> </dl> </td></tr></table> </div> <br /> <!-- ==================== CLASS VARIABLE DETAILS ==================== --> <a name="section-ClassVariableDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Class Variable Details</span></td> </tr> </table> <a name="ABOUT_MESSAGE"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">ABOUT_MESSAGE</h3> Contents of the "About" dialog. <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> 'wxmpl.PlotFrame %s\n' % __version__+ 'Written by Ken McIvor <mcivor@i<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> it.edu>\n'+ 'Copyright 2005-2009 Illinois Institute of Technology' </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="wxmpl-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" >WxMpl</th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Mon Feb 23 12:53:00 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>