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

<!DOCTYPE html>
<html><head>
<title>Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog</title>
<meta charset="UTF-8">
<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>FilePathRole</td></tr>
</table>
<h3>Class Methods</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>
<h3>Static Methods</h3>

<table>
<tr><td>None</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> (UI.UserInterface)</dt>
<dd>
reference to the UI object
</dd>
<dt><i>showConfidence</i> (bool)</dt>
<dd>
flag indicating the display of the
            confidence column
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent of this dialog
</dd>
<dt><i>name</i> (str)</dt>
<dd>
name of this dialog
</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>filename, lineno, unsure=False</i>)

<p>
        Public slot to add an entry to the list.
</p>
<dl>

<dt><i>filename</i> (str)</dt>
<dd>
full path of the matched file
</dd>
<dt><i>lineno</i> (int)</dt>
<dd>
line number of the match
</dd>
<dt><i>unsure</i> (bool)</dt>
<dd>
flag indicating an unsure match
</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>
<dl>

<dt><i>item</i> (QTreeWidgetItem)</dt>
<dd>
reference to the activated item
</dd>
<dt><i>column</i> (int)</dt>
<dd>
column the item was activated in
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>