Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UI.SearchWidget.html
Documentation/Source/eric5.UI.SearchWidget.html
- changeset 1823
- 21d988eaf1bf
- child 1830
- f2fccb8c2ab4
equal
deleted
inserted
replaced
| 1822:6ee4a434e64c | 1823:21d988eaf1bf |
|---|---|
| 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>eric5.UI.SearchWidget</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>eric5.UI.SearchWidget</h1> | |
| 24 <p> | |
| 25 Module implementing the search box for the shel, terminal and log viewer. | |
| 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="#SearchWidget">SearchWidget</a></td> | |
| 35 <td>Class implementing the search box for the shel, terminal and log viewer.</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="SearchWidget" ID="SearchWidget"></a> | |
| 44 <h2>SearchWidget</h2> | |
| 45 <p> | |
| 46 Class implementing the search box for the shel, terminal and log viewer. | |
| 47 </p><h3>Signals</h3> | |
| 48 <dl> | |
| 49 <dt>searchNext(text, caseSensitive, wholeWord)</dt> | |
| 50 <dd> | |
| 51 emitted when the user pressed | |
| 52 the next button (string, boolean, boolean) | |
| 53 </dd><dt>searchPrevious(text, caseSensitive, wholeWord)</dt> | |
| 54 <dd> | |
| 55 emitted when the user pressed | |
| 56 the previous button (string, boolean, boolean) | |
| 57 </dd> | |
| 58 </dl> | |
| 59 <h3>Derived from</h3> | |
| 60 QWidget, Ui_SearchWidget | |
| 61 <h3>Class Attributes</h3> | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 <h3>Class Methods</h3> | |
| 66 <table> | |
| 67 <tr><td>None</td></tr> | |
| 68 </table> | |
| 69 <h3>Methods</h3> | |
| 70 <table> | |
| 71 <tr> | |
| 72 <td><a href="#SearchWidget.__init__">SearchWidget</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#SearchWidget.__findByReturnPressed">__findByReturnPressed</a></td> | |
| 76 <td>Private slot to handle the returnPressed signal of the findtext combobox.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#SearchWidget.__setSearchButtons">__setSearchButtons</a></td> | |
| 79 <td>Private slot to set the state of the search buttons.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#SearchWidget.keyPressEvent">keyPressEvent</a></td> | |
| 82 <td>Protected slot to handle key press events.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#SearchWidget.on_closeButton_clicked">on_closeButton_clicked</a></td> | |
| 85 <td>Private slot to close the widget.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#SearchWidget.on_findNextButton_clicked">on_findNextButton_clicked</a></td> | |
| 88 <td>Private slot to find the next occurrence.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#SearchWidget.on_findPrevButton_clicked">on_findPrevButton_clicked</a></td> | |
| 91 <td>Private slot to find the previous occurrence.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#SearchWidget.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td> | |
| 94 <td>Private slot to enable/disable the find buttons.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#SearchWidget.showFind">showFind</a></td> | |
| 97 <td>Public method to display this widget.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <h3>Static Methods</h3> | |
| 101 <table> | |
| 102 <tr><td>None</td></tr> | |
| 103 </table> | |
| 104 <a NAME="SearchWidget.__init__" ID="SearchWidget.__init__"></a> | |
| 105 <h4>SearchWidget (Constructor)</h4> | |
| 106 <b>SearchWidget</b>(<i>mainWindow, parent=None</i>) | |
| 107 <p> | |
| 108 Constructor | |
| 109 </p><dl> | |
| 110 <dt><i>parent</i></dt> | |
| 111 <dd> | |
| 112 reference to the parent widget (QWidget) | |
| 113 </dd> | |
| 114 </dl><a NAME="SearchWidget.__findByReturnPressed" ID="SearchWidget.__findByReturnPressed"></a> | |
| 115 <h4>SearchWidget.__findByReturnPressed</h4> | |
| 116 <b>__findByReturnPressed</b>(<i></i>) | |
| 117 <p> | |
| 118 Private slot to handle the returnPressed signal of the findtext combobox. | |
| 119 </p><a NAME="SearchWidget.__setSearchButtons" ID="SearchWidget.__setSearchButtons"></a> | |
| 120 <h4>SearchWidget.__setSearchButtons</h4> | |
| 121 <b>__setSearchButtons</b>(<i>enabled</i>) | |
| 122 <p> | |
| 123 Private slot to set the state of the search buttons. | |
| 124 </p><dl> | |
| 125 <dt><i>enabled</i></dt> | |
| 126 <dd> | |
| 127 flag indicating the state (boolean) | |
| 128 </dd> | |
| 129 </dl><a NAME="SearchWidget.keyPressEvent" ID="SearchWidget.keyPressEvent"></a> | |
| 130 <h4>SearchWidget.keyPressEvent</h4> | |
| 131 <b>keyPressEvent</b>(<i>event</i>) | |
| 132 <p> | |
| 133 Protected slot to handle key press events. | |
| 134 </p><dl> | |
| 135 <dt><i>event</i></dt> | |
| 136 <dd> | |
| 137 reference to the key press event (QKeyEvent) | |
| 138 </dd> | |
| 139 </dl><a NAME="SearchWidget.on_closeButton_clicked" ID="SearchWidget.on_closeButton_clicked"></a> | |
| 140 <h4>SearchWidget.on_closeButton_clicked</h4> | |
| 141 <b>on_closeButton_clicked</b>(<i></i>) | |
| 142 <p> | |
| 143 Private slot to close the widget. | |
| 144 </p><a NAME="SearchWidget.on_findNextButton_clicked" ID="SearchWidget.on_findNextButton_clicked"></a> | |
| 145 <h4>SearchWidget.on_findNextButton_clicked</h4> | |
| 146 <b>on_findNextButton_clicked</b>(<i></i>) | |
| 147 <p> | |
| 148 Private slot to find the next occurrence. | |
| 149 </p><a NAME="SearchWidget.on_findPrevButton_clicked" ID="SearchWidget.on_findPrevButton_clicked"></a> | |
| 150 <h4>SearchWidget.on_findPrevButton_clicked</h4> | |
| 151 <b>on_findPrevButton_clicked</b>(<i></i>) | |
| 152 <p> | |
| 153 Private slot to find the previous occurrence. | |
| 154 </p><a NAME="SearchWidget.on_findtextCombo_editTextChanged" ID="SearchWidget.on_findtextCombo_editTextChanged"></a> | |
| 155 <h4>SearchWidget.on_findtextCombo_editTextChanged</h4> | |
| 156 <b>on_findtextCombo_editTextChanged</b>(<i>txt</i>) | |
| 157 <p> | |
| 158 Private slot to enable/disable the find buttons. | |
| 159 </p><dl> | |
| 160 <dt><i>txt</i></dt> | |
| 161 <dd> | |
| 162 text of the combobox (string) | |
| 163 </dd> | |
| 164 </dl><a NAME="SearchWidget.showFind" ID="SearchWidget.showFind"></a> | |
| 165 <h4>SearchWidget.showFind</h4> | |
| 166 <b>showFind</b>(<i>txt=""</i>) | |
| 167 <p> | |
| 168 Public method to display this widget. | |
| 169 </p><dl> | |
| 170 <dt><i>txt</i></dt> | |
| 171 <dd> | |
| 172 text to be shown in the combo (string) | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <div align="right"><a href="#top">Up</a></div> | |
| 176 <hr /> | |
| 177 </body></html> |
