Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Helpviewer.SearchWidget.html

eric6/Documentation/Source/eric6.Helpviewer.SearchWidget.html

changeset 6942
2602857055c5
parent 3673
e26d7d0c1088
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.SearchWidget</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Helpviewer.SearchWidget</h1>
23 <p>
24 Module implementing the search bar for the web browser.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SearchWidget">SearchWidget</a></td>
34 <td>Class implementing the search bar for the web browser.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="SearchWidget" ID="SearchWidget"></a>
43 <h2>SearchWidget</h2>
44 <p>
45 Class implementing the search bar for the web browser.
46 </p>
47 <h3>Derived from</h3>
48 QWidget, Ui_SearchWidget
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#SearchWidget.__init__">SearchWidget</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#SearchWidget.__findByReturnPressed">__findByReturnPressed</a></td>
64 <td>Private slot to handle the returnPressed signal of the findtext combobox.</td>
65 </tr><tr>
66 <td><a href="#SearchWidget.__findNextPrev">__findNextPrev</a></td>
67 <td>Private slot to find the next occurrence of text.</td>
68 </tr><tr>
69 <td><a href="#SearchWidget.__searchTextEdited">__searchTextEdited</a></td>
70 <td>Private slot to perform an incremental search.</td>
71 </tr><tr>
72 <td><a href="#SearchWidget.__setFindtextComboBackground">__setFindtextComboBackground</a></td>
73 <td>Private slot to change the findtext combo background to indicate errors.</td>
74 </tr><tr>
75 <td><a href="#SearchWidget.findNext">findNext</a></td>
76 <td>Public slot to find the next occurrence.</td>
77 </tr><tr>
78 <td><a href="#SearchWidget.findPrevious">findPrevious</a></td>
79 <td>Public slot to find the previous occurrence.</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.on_highlightAllCheckBox_toggled">on_highlightAllCheckBox_toggled</a></td>
97 <td>Private slot to toggle the highlight of all occurrences.</td>
98 </tr><tr>
99 <td><a href="#SearchWidget.showFind">showFind</a></td>
100 <td>Public method to display this dialog.</td>
101 </tr>
102 </table>
103 <h3>Static Methods</h3>
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107 <a NAME="SearchWidget.__init__" ID="SearchWidget.__init__"></a>
108 <h4>SearchWidget (Constructor)</h4>
109 <b>SearchWidget</b>(<i>mainWindow, parent=None</i>)
110 <p>
111 Constructor
112 </p><dl>
113 <dt><i>mainWindow</i></dt>
114 <dd>
115 reference to the main window (QMainWindow)
116 </dd><dt><i>parent</i></dt>
117 <dd>
118 parent widget of this dialog (QWidget)
119 </dd>
120 </dl><a NAME="SearchWidget.__findByReturnPressed" ID="SearchWidget.__findByReturnPressed"></a>
121 <h4>SearchWidget.__findByReturnPressed</h4>
122 <b>__findByReturnPressed</b>(<i></i>)
123 <p>
124 Private slot to handle the returnPressed signal of the findtext
125 combobox.
126 </p><a NAME="SearchWidget.__findNextPrev" ID="SearchWidget.__findNextPrev"></a>
127 <h4>SearchWidget.__findNextPrev</h4>
128 <b>__findNextPrev</b>(<i></i>)
129 <p>
130 Private slot to find the next occurrence of text.
131 </p><a NAME="SearchWidget.__searchTextEdited" ID="SearchWidget.__searchTextEdited"></a>
132 <h4>SearchWidget.__searchTextEdited</h4>
133 <b>__searchTextEdited</b>(<i>txt</i>)
134 <p>
135 Private slot to perform an incremental search.
136 </p><dl>
137 <dt><i>txt</i></dt>
138 <dd>
139 current text of the search combos line edit (string)
140 (unused)
141 </dd>
142 </dl><a NAME="SearchWidget.__setFindtextComboBackground" ID="SearchWidget.__setFindtextComboBackground"></a>
143 <h4>SearchWidget.__setFindtextComboBackground</h4>
144 <b>__setFindtextComboBackground</b>(<i>error</i>)
145 <p>
146 Private slot to change the findtext combo background to indicate
147 errors.
148 </p><dl>
149 <dt><i>error</i></dt>
150 <dd>
151 flag indicating an error condition (boolean)
152 </dd>
153 </dl><a NAME="SearchWidget.findNext" ID="SearchWidget.findNext"></a>
154 <h4>SearchWidget.findNext</h4>
155 <b>findNext</b>(<i></i>)
156 <p>
157 Public slot to find the next occurrence.
158 </p><a NAME="SearchWidget.findPrevious" ID="SearchWidget.findPrevious"></a>
159 <h4>SearchWidget.findPrevious</h4>
160 <b>findPrevious</b>(<i></i>)
161 <p>
162 Public slot to find the previous occurrence.
163 </p><a NAME="SearchWidget.keyPressEvent" ID="SearchWidget.keyPressEvent"></a>
164 <h4>SearchWidget.keyPressEvent</h4>
165 <b>keyPressEvent</b>(<i>event</i>)
166 <p>
167 Protected slot to handle key press events.
168 </p><dl>
169 <dt><i>event</i></dt>
170 <dd>
171 reference to the key press event (QKeyEvent)
172 </dd>
173 </dl><a NAME="SearchWidget.on_closeButton_clicked" ID="SearchWidget.on_closeButton_clicked"></a>
174 <h4>SearchWidget.on_closeButton_clicked</h4>
175 <b>on_closeButton_clicked</b>(<i></i>)
176 <p>
177 Private slot to close the widget.
178 </p><a NAME="SearchWidget.on_findNextButton_clicked" ID="SearchWidget.on_findNextButton_clicked"></a>
179 <h4>SearchWidget.on_findNextButton_clicked</h4>
180 <b>on_findNextButton_clicked</b>(<i></i>)
181 <p>
182 Private slot to find the next occurrence.
183 </p><a NAME="SearchWidget.on_findPrevButton_clicked" ID="SearchWidget.on_findPrevButton_clicked"></a>
184 <h4>SearchWidget.on_findPrevButton_clicked</h4>
185 <b>on_findPrevButton_clicked</b>(<i></i>)
186 <p>
187 Private slot to find the previous occurrence.
188 </p><a NAME="SearchWidget.on_findtextCombo_editTextChanged" ID="SearchWidget.on_findtextCombo_editTextChanged"></a>
189 <h4>SearchWidget.on_findtextCombo_editTextChanged</h4>
190 <b>on_findtextCombo_editTextChanged</b>(<i>txt</i>)
191 <p>
192 Private slot to enable/disable the find buttons.
193 </p><dl>
194 <dt><i>txt</i></dt>
195 <dd>
196 text of the combobox (string)
197 </dd>
198 </dl><a NAME="SearchWidget.on_highlightAllCheckBox_toggled" ID="SearchWidget.on_highlightAllCheckBox_toggled"></a>
199 <h4>SearchWidget.on_highlightAllCheckBox_toggled</h4>
200 <b>on_highlightAllCheckBox_toggled</b>(<i>checked</i>)
201 <p>
202 Private slot to toggle the highlight of all occurrences.
203 </p><dl>
204 <dt><i>checked</i></dt>
205 <dd>
206 flag indicating the check box toggle state (boolean)
207 </dd>
208 </dl><a NAME="SearchWidget.showFind" ID="SearchWidget.showFind"></a>
209 <h4>SearchWidget.showFind</h4>
210 <b>showFind</b>(<i></i>)
211 <p>
212 Public method to display this dialog.
213 </p>
214 <div align="right"><a href="#top">Up</a></div>
215 <hr />
216 </body></html>

Mercurial Repository: eric

eric ide

mercurial