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 17
- a0fac63ef73f
- child 24
- e18b36080a37
equal
deleted
inserted
replaced
| 16:65b340b40844 | 17:a0fac63ef73f |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>Plugin_Refactoring_Rope.RefactoringRope.HelpDialog</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.HelpDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog to show help about rope. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#HelpDialog">HelpDialog</a></td> | |
| 35 <td>Class implementing a dialog to show help about rope.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="HelpDialog" ID="HelpDialog"></a> | |
| 44 <h2>HelpDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to show help about rope. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QDialog, Ui_HelpDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#HelpDialog.__init__">HelpDialog</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#HelpDialog.findNextPrev">findNextPrev</a></td> | |
| 61 <td>Public slot to find the next occurrence of a text.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#HelpDialog.helpWidget">helpWidget</a></td> | |
| 64 <td>Public method to get a reference to the help widget.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#HelpDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 67 <td>Private slot called by a button of the button box clicked.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <a NAME="HelpDialog.__init__" ID="HelpDialog.__init__"></a> | |
| 71 <h4>HelpDialog (Constructor)</h4> | |
| 72 <b>HelpDialog</b>(<i>title, helpfile, parent = None</i>) | |
| 73 <p> | |
| 74 Constructor | |
| 75 </p><dl> | |
| 76 <dt><i>title</i></dt> | |
| 77 <dd> | |
| 78 window title (string) | |
| 79 </dd><dt><i>helpfile</i></dt> | |
| 80 <dd> | |
| 81 filename of the helpfile (string) | |
| 82 </dd><dt><i>parent</i></dt> | |
| 83 <dd> | |
| 84 reference to the parent widget (QWidget) | |
| 85 </dd> | |
| 86 </dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a> | |
| 87 <h4>HelpDialog.findNextPrev</h4> | |
| 88 <b>findNextPrev</b>(<i>txt, case, word, backwards</i>) | |
| 89 <p> | |
| 90 Public slot to find the next occurrence of a text. | |
| 91 </p><dl> | |
| 92 <dt><i>txt</i></dt> | |
| 93 <dd> | |
| 94 text to search for (string) | |
| 95 </dd><dt><i>case</i></dt> | |
| 96 <dd> | |
| 97 flag indicating a case sensitive search (boolean) | |
| 98 </dd><dt><i>word</i></dt> | |
| 99 <dd> | |
| 100 flag indicating a word based search (boolean) | |
| 101 </dd><dt><i>backwards</i></dt> | |
| 102 <dd> | |
| 103 flag indicating a backwards search (boolean) | |
| 104 </dd> | |
| 105 </dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a> | |
| 106 <h4>HelpDialog.helpWidget</h4> | |
| 107 <b>helpWidget</b>(<i></i>) | |
| 108 <p> | |
| 109 Public method to get a reference to the help widget. | |
| 110 </p><dl> | |
| 111 <dt>Returns:</dt> | |
| 112 <dd> | |
| 113 reference to the help widget (QTextEdit) | |
| 114 </dd> | |
| 115 </dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a> | |
| 116 <h4>HelpDialog.on_buttonBox_clicked</h4> | |
| 117 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 118 <p> | |
| 119 Private slot called by a button of the button box clicked. | |
| 120 </p><dl> | |
| 121 <dt><i>button</i></dt> | |
| 122 <dd> | |
| 123 button that was clicked (QAbstractButton) | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <div align="right"><a href="#top">Up</a></div> | |
| 127 <hr /> | |
| 128 </body></html> |
