Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html
- changeset 321
- d51e810107ec
- parent 204
- b4bf79b956bc
- child 347
- b5048b5ff454
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.HelpDialog</h1> | 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.HelpDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a dialog to show help about rope. | 26 Module implementing a dialog to show help about rope. |
| 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="#HelpDialog">HelpDialog</a></td> | 38 <td><a href="#HelpDialog">HelpDialog</a></td> |
| 34 <td>Class implementing a dialog to show help about rope.</td> | 39 <td>Class implementing a dialog to show help about rope.</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="HelpDialog" ID="HelpDialog"></a> | 49 <a NAME="HelpDialog" ID="HelpDialog"></a> |
| 43 <h2>HelpDialog</h2> | 50 <h2>HelpDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a dialog to show help about rope. | 53 Class implementing a dialog to show help about rope. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QDialog, Ui_HelpDialog | 56 QDialog, Ui_HelpDialog |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</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="#HelpDialog.__init__">HelpDialog</a></td> | 72 <td><a href="#HelpDialog.__init__">HelpDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#HelpDialog.findNextPrev">findNextPrev</a></td> | 76 <td><a href="#HelpDialog.findNextPrev">findNextPrev</a></td> |
| 64 <td>Public slot to find the next occurrence of a text.</td> | 77 <td>Public slot to find the next occurrence of a text.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#HelpDialog.helpWidget">helpWidget</a></td> | 80 <td><a href="#HelpDialog.helpWidget">helpWidget</a></td> |
| 67 <td>Public method to get a reference to the help widget.</td> | 81 <td>Public method to get a reference to the help widget.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#HelpDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 84 <td><a href="#HelpDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 70 <td>Private slot called by a button of the button box clicked.</td> | 85 <td>Private slot called by a button of the button box clicked.</td> |
| 71 </tr> | 86 </tr> |
| 72 </table> | 87 </table> |
| 73 <h3>Static Methods</h3> | 88 <h3>Static Methods</h3> |
| 89 | |
| 74 <table> | 90 <table> |
| 75 <tr><td>None</td></tr> | 91 <tr><td>None</td></tr> |
| 76 </table> | 92 </table> |
| 93 | |
| 77 <a NAME="HelpDialog.__init__" ID="HelpDialog.__init__"></a> | 94 <a NAME="HelpDialog.__init__" ID="HelpDialog.__init__"></a> |
| 78 <h4>HelpDialog (Constructor)</h4> | 95 <h4>HelpDialog (Constructor)</h4> |
| 79 <b>HelpDialog</b>(<i>title, helpfile, parent=None</i>) | 96 <b>HelpDialog</b>(<i>title, helpfile, parent=None</i>) |
| 97 | |
| 80 <p> | 98 <p> |
| 81 Constructor | 99 Constructor |
| 82 </p><dl> | 100 </p> |
| 101 <dl> | |
| 102 | |
| 83 <dt><i>title</i> (str)</dt> | 103 <dt><i>title</i> (str)</dt> |
| 84 <dd> | 104 <dd> |
| 85 window title | 105 window title |
| 86 </dd><dt><i>helpfile</i> (str)</dt> | 106 </dd> |
| 107 <dt><i>helpfile</i> (str)</dt> | |
| 87 <dd> | 108 <dd> |
| 88 filename of the helpfile | 109 filename of the helpfile |
| 89 </dd><dt><i>parent</i> (QWidget)</dt> | 110 </dd> |
| 111 <dt><i>parent</i> (QWidget)</dt> | |
| 90 <dd> | 112 <dd> |
| 91 reference to the parent widget | 113 reference to the parent widget |
| 92 </dd> | 114 </dd> |
| 93 </dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a> | 115 </dl> |
| 116 <a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a> | |
| 94 <h4>HelpDialog.findNextPrev</h4> | 117 <h4>HelpDialog.findNextPrev</h4> |
| 95 <b>findNextPrev</b>(<i>txt, case, word, backwards</i>) | 118 <b>findNextPrev</b>(<i>txt, case, word, backwards</i>) |
| 119 | |
| 96 <p> | 120 <p> |
| 97 Public slot to find the next occurrence of a text. | 121 Public slot to find the next occurrence of a text. |
| 98 </p><dl> | 122 </p> |
| 123 <dl> | |
| 124 | |
| 99 <dt><i>txt</i> (str)</dt> | 125 <dt><i>txt</i> (str)</dt> |
| 100 <dd> | 126 <dd> |
| 101 text to search for | 127 text to search for |
| 102 </dd><dt><i>case</i> (bool)</dt> | 128 </dd> |
| 129 <dt><i>case</i> (bool)</dt> | |
| 103 <dd> | 130 <dd> |
| 104 flag indicating a case sensitive search | 131 flag indicating a case sensitive search |
| 105 </dd><dt><i>word</i> (bool)</dt> | 132 </dd> |
| 133 <dt><i>word</i> (bool)</dt> | |
| 106 <dd> | 134 <dd> |
| 107 flag indicating a word based search | 135 flag indicating a word based search |
| 108 </dd><dt><i>backwards</i> (bool)</dt> | 136 </dd> |
| 137 <dt><i>backwards</i> (bool)</dt> | |
| 109 <dd> | 138 <dd> |
| 110 flag indicating a backwards search | 139 flag indicating a backwards search |
| 111 </dd> | 140 </dd> |
| 112 </dl><dl> | 141 </dl> |
| 142 <dl> | |
| 113 <dt>Returns:</dt> | 143 <dt>Returns:</dt> |
| 114 <dd> | 144 <dd> |
| 115 flag indicating the search found another occurrence | 145 flag indicating the search found another occurrence |
| 116 </dd> | 146 </dd> |
| 117 </dl><dl> | 147 </dl> |
| 148 <dl> | |
| 118 <dt>Return Type:</dt> | 149 <dt>Return Type:</dt> |
| 119 <dd> | 150 <dd> |
| 120 bool | 151 bool |
| 121 </dd> | 152 </dd> |
| 122 </dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a> | 153 </dl> |
| 154 <a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a> | |
| 123 <h4>HelpDialog.helpWidget</h4> | 155 <h4>HelpDialog.helpWidget</h4> |
| 124 <b>helpWidget</b>(<i></i>) | 156 <b>helpWidget</b>(<i></i>) |
| 157 | |
| 125 <p> | 158 <p> |
| 126 Public method to get a reference to the help widget. | 159 Public method to get a reference to the help widget. |
| 127 </p><dl> | 160 </p> |
| 161 <dl> | |
| 128 <dt>Returns:</dt> | 162 <dt>Returns:</dt> |
| 129 <dd> | 163 <dd> |
| 130 reference to the help widget | 164 reference to the help widget |
| 131 </dd> | 165 </dd> |
| 132 </dl><dl> | 166 </dl> |
| 167 <dl> | |
| 133 <dt>Return Type:</dt> | 168 <dt>Return Type:</dt> |
| 134 <dd> | 169 <dd> |
| 135 QTextEdit | 170 QTextEdit |
| 136 </dd> | 171 </dd> |
| 137 </dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a> | 172 </dl> |
| 173 <a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a> | |
| 138 <h4>HelpDialog.on_buttonBox_clicked</h4> | 174 <h4>HelpDialog.on_buttonBox_clicked</h4> |
| 139 <b>on_buttonBox_clicked</b>(<i>button</i>) | 175 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 176 | |
| 140 <p> | 177 <p> |
| 141 Private slot called by a button of the button box clicked. | 178 Private slot called by a button of the button box clicked. |
| 142 </p><dl> | 179 </p> |
| 180 <dl> | |
| 181 | |
| 143 <dt><i>button</i> (QAbstractButton)</dt> | 182 <dt><i>button</i> (QAbstractButton)</dt> |
| 144 <dd> | 183 <dd> |
| 145 button that was clicked | 184 button that was clicked |
| 146 </dd> | 185 </dd> |
| 147 </dl> | 186 </dl> |
