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

changeset 321
d51e810107ec
parent 204
b4bf79b956bc
child 375
c61a2f18ed78
equal deleted inserted replaced
320:91b171fdd85f 321:d51e810107ec
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog</h1> 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to show matching references/definitions. 26 Module implementing a dialog to show matching references/definitions.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#MatchesDialog">MatchesDialog</a></td> 38 <td><a href="#MatchesDialog">MatchesDialog</a></td>
34 <td>Class implementing a dialog to show matching references/definitions.</td> 39 <td>Class implementing a dialog to show matching references/definitions.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="MatchesDialog" ID="MatchesDialog"></a> 49 <a NAME="MatchesDialog" ID="MatchesDialog"></a>
43 <h2>MatchesDialog</h2> 50 <h2>MatchesDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to show matching references/definitions. 53 Class implementing a dialog to show matching references/definitions.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_MatchesDialog 56 QDialog, Ui_MatchesDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>FilePathRole</td></tr> 60 <tr><td>FilePathRole</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#MatchesDialog.__init__">MatchesDialog</a></td> 72 <td><a href="#MatchesDialog.__init__">MatchesDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#MatchesDialog.__resizeColumns">__resizeColumns</a></td> 76 <td><a href="#MatchesDialog.__resizeColumns">__resizeColumns</a></td>
64 <td>Private method to resize the list columns.</td> 77 <td>Private method to resize the list columns.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#MatchesDialog.__resort">__resort</a></td> 80 <td><a href="#MatchesDialog.__resort">__resort</a></td>
67 <td>Private method to resort the tree.</td> 81 <td>Private method to resort the tree.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#MatchesDialog.addEntry">addEntry</a></td> 84 <td><a href="#MatchesDialog.addEntry">addEntry</a></td>
70 <td>Public slot to add an entry to the list.</td> 85 <td>Public slot to add an entry to the list.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#MatchesDialog.on_matchesList_itemActivated">on_matchesList_itemActivated</a></td> 88 <td><a href="#MatchesDialog.on_matchesList_itemActivated">on_matchesList_itemActivated</a></td>
73 <td>Private slot to handle the itemActivated signal of the list.</td> 89 <td>Private slot to handle the itemActivated signal of the list.</td>
74 </tr> 90 </tr>
75 </table> 91 </table>
76 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
93
77 <table> 94 <table>
78 <tr><td>None</td></tr> 95 <tr><td>None</td></tr>
79 </table> 96 </table>
97
80 <a NAME="MatchesDialog.__init__" ID="MatchesDialog.__init__"></a> 98 <a NAME="MatchesDialog.__init__" ID="MatchesDialog.__init__"></a>
81 <h4>MatchesDialog (Constructor)</h4> 99 <h4>MatchesDialog (Constructor)</h4>
82 <b>MatchesDialog</b>(<i>ui, showConfidence, parent=None, name=None</i>) 100 <b>MatchesDialog</b>(<i>ui, showConfidence, parent=None, name=None</i>)
101
83 <p> 102 <p>
84 Constructor 103 Constructor
85 </p><dl> 104 </p>
105 <dl>
106
86 <dt><i>ui</i> (UI.UserInterface)</dt> 107 <dt><i>ui</i> (UI.UserInterface)</dt>
87 <dd> 108 <dd>
88 reference to the UI object 109 reference to the UI object
89 </dd><dt><i>showConfidence</i> (bool)</dt> 110 </dd>
111 <dt><i>showConfidence</i> (bool)</dt>
90 <dd> 112 <dd>
91 flag indicating the display of the 113 flag indicating the display of the
92 confidence column 114 confidence column
93 </dd><dt><i>parent</i> (QWidget)</dt> 115 </dd>
116 <dt><i>parent</i> (QWidget)</dt>
94 <dd> 117 <dd>
95 parent of this dialog 118 parent of this dialog
96 </dd><dt><i>name</i> (str)</dt> 119 </dd>
120 <dt><i>name</i> (str)</dt>
97 <dd> 121 <dd>
98 name of this dialog 122 name of this dialog
99 </dd> 123 </dd>
100 </dl><a NAME="MatchesDialog.__resizeColumns" ID="MatchesDialog.__resizeColumns"></a> 124 </dl>
125 <a NAME="MatchesDialog.__resizeColumns" ID="MatchesDialog.__resizeColumns"></a>
101 <h4>MatchesDialog.__resizeColumns</h4> 126 <h4>MatchesDialog.__resizeColumns</h4>
102 <b>__resizeColumns</b>(<i></i>) 127 <b>__resizeColumns</b>(<i></i>)
128
103 <p> 129 <p>
104 Private method to resize the list columns. 130 Private method to resize the list columns.
105 </p><a NAME="MatchesDialog.__resort" ID="MatchesDialog.__resort"></a> 131 </p>
132 <a NAME="MatchesDialog.__resort" ID="MatchesDialog.__resort"></a>
106 <h4>MatchesDialog.__resort</h4> 133 <h4>MatchesDialog.__resort</h4>
107 <b>__resort</b>(<i></i>) 134 <b>__resort</b>(<i></i>)
135
108 <p> 136 <p>
109 Private method to resort the tree. 137 Private method to resort the tree.
110 </p><a NAME="MatchesDialog.addEntry" ID="MatchesDialog.addEntry"></a> 138 </p>
139 <a NAME="MatchesDialog.addEntry" ID="MatchesDialog.addEntry"></a>
111 <h4>MatchesDialog.addEntry</h4> 140 <h4>MatchesDialog.addEntry</h4>
112 <b>addEntry</b>(<i>filename, lineno, unsure=False</i>) 141 <b>addEntry</b>(<i>filename, lineno, unsure=False</i>)
142
113 <p> 143 <p>
114 Public slot to add an entry to the list. 144 Public slot to add an entry to the list.
115 </p><dl> 145 </p>
146 <dl>
147
116 <dt><i>filename</i> (str)</dt> 148 <dt><i>filename</i> (str)</dt>
117 <dd> 149 <dd>
118 full path of the matched file 150 full path of the matched file
119 </dd><dt><i>lineno</i> (int)</dt> 151 </dd>
152 <dt><i>lineno</i> (int)</dt>
120 <dd> 153 <dd>
121 line number of the match 154 line number of the match
122 </dd><dt><i>unsure</i> (bool)</dt> 155 </dd>
156 <dt><i>unsure</i> (bool)</dt>
123 <dd> 157 <dd>
124 flag indicating an unsure match 158 flag indicating an unsure match
125 </dd> 159 </dd>
126 </dl><a NAME="MatchesDialog.on_matchesList_itemActivated" ID="MatchesDialog.on_matchesList_itemActivated"></a> 160 </dl>
161 <a NAME="MatchesDialog.on_matchesList_itemActivated" ID="MatchesDialog.on_matchesList_itemActivated"></a>
127 <h4>MatchesDialog.on_matchesList_itemActivated</h4> 162 <h4>MatchesDialog.on_matchesList_itemActivated</h4>
128 <b>on_matchesList_itemActivated</b>(<i>item, column</i>) 163 <b>on_matchesList_itemActivated</b>(<i>item, column</i>)
164
129 <p> 165 <p>
130 Private slot to handle the itemActivated signal of the list. 166 Private slot to handle the itemActivated signal of the list.
131 </p><dl> 167 </p>
168 <dl>
169
132 <dt><i>item</i> (QTreeWidgetItem)</dt> 170 <dt><i>item</i> (QTreeWidgetItem)</dt>
133 <dd> 171 <dd>
134 reference to the activated item 172 reference to the activated item
135 </dd><dt><i>column</i> (int)</dt> 173 </dd>
174 <dt><i>column</i> (int)</dt>
136 <dd> 175 <dd>
137 column the item was activated in 176 column the item was activated in
138 </dd> 177 </dd>
139 </dl> 178 </dl>
140 <div align="right"><a href="#top">Up</a></div> 179 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial