|
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.Helpviewer.SearchWidget</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Helpviewer.SearchWidget</h1> |
|
12 <p> |
|
13 Module implementing the search bar for the web browser. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#SearchWidget">SearchWidget</a></td> |
|
23 <td>Class implementing the search bar for the web browser.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="SearchWidget" ID="SearchWidget"></a> |
|
32 <h2>SearchWidget</h2> |
|
33 <p> |
|
34 Class implementing the search bar for the web browser. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QWidget, Ui_SearchWidget |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#SearchWidget.__init__">SearchWidget</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#SearchWidget.__findByReturnPressed">__findByReturnPressed</a></td> |
|
49 <td>Private slot to handle the returnPressed signal of the findtext combobox.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#SearchWidget.__findNextPrev">__findNextPrev</a></td> |
|
52 <td>Private slot to find the next occurrence of text.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#SearchWidget.__setFindtextComboBackground">__setFindtextComboBackground</a></td> |
|
55 <td>Private slot to change the findtext combo background to indicate errors.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#SearchWidget.findNext">findNext</a></td> |
|
58 <td>Public slot to find the next occurrence.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#SearchWidget.findPrevious">findPrevious</a></td> |
|
61 <td>Public slot to find the previous occurrence.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#SearchWidget.keyPressEvent">keyPressEvent</a></td> |
|
64 <td>Protected slot to handle key press events.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#SearchWidget.on_closeButton_clicked">on_closeButton_clicked</a></td> |
|
67 <td>Private slot to close the widget.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#SearchWidget.on_findNextButton_clicked">on_findNextButton_clicked</a></td> |
|
70 <td>Private slot to find the next occurrence.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#SearchWidget.on_findPrevButton_clicked">on_findPrevButton_clicked</a></td> |
|
73 <td>Private slot to find the previous occurrence.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#SearchWidget.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td> |
|
76 <td>Private slot to enable/disable the find buttons.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#SearchWidget.showFind">showFind</a></td> |
|
79 <td>Public method to display this dialog.</td> |
|
80 </tr> |
|
81 </table> |
|
82 <a NAME="SearchWidget.__init__" ID="SearchWidget.__init__"></a> |
|
83 <h4>SearchWidget (Constructor)</h4> |
|
84 <b>SearchWidget</b>(<i>mainWindow, parent = None</i>) |
|
85 <p> |
|
86 Constructor |
|
87 </p><dl> |
|
88 <dt><i>mainWindow</i></dt> |
|
89 <dd> |
|
90 reference to the main window (QMainWindow) |
|
91 </dd><dt><i>parent</i></dt> |
|
92 <dd> |
|
93 parent widget of this dialog (QWidget) |
|
94 </dd> |
|
95 </dl><a NAME="SearchWidget.__findByReturnPressed" ID="SearchWidget.__findByReturnPressed"></a> |
|
96 <h4>SearchWidget.__findByReturnPressed</h4> |
|
97 <b>__findByReturnPressed</b>(<i></i>) |
|
98 <p> |
|
99 Private slot to handle the returnPressed signal of the findtext combobox. |
|
100 </p><a NAME="SearchWidget.__findNextPrev" ID="SearchWidget.__findNextPrev"></a> |
|
101 <h4>SearchWidget.__findNextPrev</h4> |
|
102 <b>__findNextPrev</b>(<i></i>) |
|
103 <p> |
|
104 Private slot to find the next occurrence of text. |
|
105 </p><a NAME="SearchWidget.__setFindtextComboBackground" ID="SearchWidget.__setFindtextComboBackground"></a> |
|
106 <h4>SearchWidget.__setFindtextComboBackground</h4> |
|
107 <b>__setFindtextComboBackground</b>(<i>error</i>) |
|
108 <p> |
|
109 Private slot to change the findtext combo background to indicate errors. |
|
110 </p><dl> |
|
111 <dt><i>error</i></dt> |
|
112 <dd> |
|
113 flag indicating an error condition (boolean) |
|
114 </dd> |
|
115 </dl><a NAME="SearchWidget.findNext" ID="SearchWidget.findNext"></a> |
|
116 <h4>SearchWidget.findNext</h4> |
|
117 <b>findNext</b>(<i></i>) |
|
118 <p> |
|
119 Public slot to find the next occurrence. |
|
120 </p><a NAME="SearchWidget.findPrevious" ID="SearchWidget.findPrevious"></a> |
|
121 <h4>SearchWidget.findPrevious</h4> |
|
122 <b>findPrevious</b>(<i></i>) |
|
123 <p> |
|
124 Public slot to find the previous occurrence. |
|
125 </p><a NAME="SearchWidget.keyPressEvent" ID="SearchWidget.keyPressEvent"></a> |
|
126 <h4>SearchWidget.keyPressEvent</h4> |
|
127 <b>keyPressEvent</b>(<i>event</i>) |
|
128 <p> |
|
129 Protected slot to handle key press events. |
|
130 </p><dl> |
|
131 <dt><i>event</i></dt> |
|
132 <dd> |
|
133 reference to the key press event (QKeyEvent) |
|
134 </dd> |
|
135 </dl><a NAME="SearchWidget.on_closeButton_clicked" ID="SearchWidget.on_closeButton_clicked"></a> |
|
136 <h4>SearchWidget.on_closeButton_clicked</h4> |
|
137 <b>on_closeButton_clicked</b>(<i></i>) |
|
138 <p> |
|
139 Private slot to close the widget. |
|
140 </p><a NAME="SearchWidget.on_findNextButton_clicked" ID="SearchWidget.on_findNextButton_clicked"></a> |
|
141 <h4>SearchWidget.on_findNextButton_clicked</h4> |
|
142 <b>on_findNextButton_clicked</b>(<i></i>) |
|
143 <p> |
|
144 Private slot to find the next occurrence. |
|
145 </p><a NAME="SearchWidget.on_findPrevButton_clicked" ID="SearchWidget.on_findPrevButton_clicked"></a> |
|
146 <h4>SearchWidget.on_findPrevButton_clicked</h4> |
|
147 <b>on_findPrevButton_clicked</b>(<i></i>) |
|
148 <p> |
|
149 Private slot to find the previous occurrence. |
|
150 </p><a NAME="SearchWidget.on_findtextCombo_editTextChanged" ID="SearchWidget.on_findtextCombo_editTextChanged"></a> |
|
151 <h4>SearchWidget.on_findtextCombo_editTextChanged</h4> |
|
152 <b>on_findtextCombo_editTextChanged</b>(<i>txt</i>) |
|
153 <p> |
|
154 Private slot to enable/disable the find buttons. |
|
155 </p><dl> |
|
156 <dt><i>txt</i></dt> |
|
157 <dd> |
|
158 text of the combobox (string) |
|
159 </dd> |
|
160 </dl><a NAME="SearchWidget.showFind" ID="SearchWidget.showFind"></a> |
|
161 <h4>SearchWidget.showFind</h4> |
|
162 <b>showFind</b>(<i></i>) |
|
163 <p> |
|
164 Public method to display this dialog. |
|
165 </p> |
|
166 <div align="right"><a href="#top">Up</a></div> |
|
167 <hr /> |
|
168 </body></html> |