RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog.html

changeset 17
a0fac63ef73f
child 24
e18b36080a37
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog.html	Sun Jan 30 18:26:37 2011 +0100
@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog</title>
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog</h1>
+<p>
+Module implementing a dialog to show matching references/definitions.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#MatchesDialog">MatchesDialog</a></td>
+<td>Class implementing a dialog to show matching references/definitions.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="MatchesDialog" ID="MatchesDialog"></a>
+<h2>MatchesDialog</h2>
+<p>
+    Class implementing a dialog to show matching references/definitions.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_MatchesDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#MatchesDialog.__init__">MatchesDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#MatchesDialog.__resizeColumns">__resizeColumns</a></td>
+<td>Private method to resize the list columns.</td>
+</tr><tr>
+<td><a href="#MatchesDialog.__resort">__resort</a></td>
+<td>Private method to resort the tree.</td>
+</tr><tr>
+<td><a href="#MatchesDialog.addEntry">addEntry</a></td>
+<td>Public slot to add an entry to the list.</td>
+</tr><tr>
+<td><a href="#MatchesDialog.on_matchesList_itemActivated">on_matchesList_itemActivated</a></td>
+<td>Private slot to handle the itemActivated signal of the list.</td>
+</tr>
+</table>
+<a NAME="MatchesDialog.__init__" ID="MatchesDialog.__init__"></a>
+<h4>MatchesDialog (Constructor)</h4>
+<b>MatchesDialog</b>(<i>ui, showConfidence, parent = None, name = None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>ui</i></dt>
+<dd>
+reference to the UI object
+</dd><dt><i>showConfidence</i></dt>
+<dd>
+flag indicating the display of the
+            confidence column (boolean)
+</dd><dt><i>parent</i></dt>
+<dd>
+parent of this dialog (QWidget)
+</dd><dt><i>name</i></dt>
+<dd>
+name of this dialog (string)
+</dd>
+</dl><a NAME="MatchesDialog.__resizeColumns" ID="MatchesDialog.__resizeColumns"></a>
+<h4>MatchesDialog.__resizeColumns</h4>
+<b>__resizeColumns</b>(<i></i>)
+<p>
+        Private method to resize the list columns.
+</p><a NAME="MatchesDialog.__resort" ID="MatchesDialog.__resort"></a>
+<h4>MatchesDialog.__resort</h4>
+<b>__resort</b>(<i></i>)
+<p>
+        Private method to resort the tree.
+</p><a NAME="MatchesDialog.addEntry" ID="MatchesDialog.addEntry"></a>
+<h4>MatchesDialog.addEntry</h4>
+<b>addEntry</b>(<i>resource, lineno, unsure=False</i>)
+<p>
+        Public slot to add an entry to the list.
+</p><dl>
+<dt><i>resource</i></dt>
+<dd>
+reference to the resource object
+            (rope.base.resources.Resource)
+</dd><dt><i>lineno</i></dt>
+<dd>
+linenumber of the match (integer)
+</dd><dt><i>unsure</i></dt>
+<dd>
+flag indicating an unsure match (boolean)
+</dd>
+</dl><a NAME="MatchesDialog.on_matchesList_itemActivated" ID="MatchesDialog.on_matchesList_itemActivated"></a>
+<h4>MatchesDialog.on_matchesList_itemActivated</h4>
+<b>on_matchesList_itemActivated</b>(<i>item, column</i>)
+<p>
+        Private slot to handle the itemActivated signal of the list.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial