Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.HelpSearchWidget.html

Documentation/Source/eric5.Helpviewer.HelpSearchWidget.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Helpviewer.HelpSearchWidget</h1> 23 <h1>eric5.Helpviewer.HelpSearchWidget</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#105;&#110;&#100;&#101;x. 25 Module implementing a window for showing the QtHelp index.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td> 34 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#105;&#110;&#100;&#101;x.</td> 35 <td>Class implementing a window for showing the QtHelp index.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a> 43 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a>
44 <h2>HelpSearchWidget</h2> 44 <h2>HelpSearchWidget</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#105;&#110;&#100;&#111;w &#102;&#111;&#114; &#115;&#104;&#111;w&#105;&#110;&#103; &#116;&#104;&#101; &#81;&#116;&#72;&#101;&#108;&#112; &#105;&#110;&#100;&#101;x. 46 Class implementing a window for showing the QtHelp index.
47 </p><h4>Signals</h4> 47 </p><h4>Signals</h4>
48 <dl> 48 <dl>
49 <dt>escapePressed()</dt> 49 <dt>escapePressed()</dt>
50 <dd> 50 <dd>
51 &#101;&#109;&#105;&#116;&#116;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#69;&#83;&#67; &#107;&#101;y w&#97;&#115; &#112;&#114;&#101;&#115;&#115;&#101;&#100; 51 emitted when the ESC key was pressed
52 </dd><dt>linkActivated(const QUrl&)</dt> 52 </dd><dt>linkActivated(const QUrl&)</dt>
53 <dd> 53 <dd>
54 &#101;&#109;&#105;&#116;&#116;&#101;&#100; w&#104;&#101;&#110; &#97; &#115;&#101;&#97;&#114;&#99;&#104; &#114;&#101;&#115;&#117;&#108;&#116; &#101;&#110;&#116;&#114;y &#105;&#115; &#97;&#99;&#116;&#105;v&#97;&#116;&#101;&#100; 54 emitted when a search result entry is activated
55 </dd> 55 </dd>
56 </dl> 56 </dl>
57 <h3>Derived from</h3> 57 <h3>Derived from</h3>
58 QWidget 58 QWidget
59 <h3>Class Attributes</h3> 59 <h3>Class Attributes</h3>
62 </table> 62 </table>
63 <h3>Methods</h3> 63 <h3>Methods</h3>
64 <table> 64 <table>
65 <tr> 65 <tr>
66 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td> 66 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td>
67 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 67 <td>Constructor</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#HelpSearchWidget.__search">__search</a></td> 69 <td><a href="#HelpSearchWidget.__search">__search</a></td>
70 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#97; &#115;&#101;&#97;&#114;&#99;&#104; &#111;&#102; &#116;&#104;&#101; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;.</td> 70 <td>Private slot to perform a search of the database.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td> 72 <td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td>
73 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#97;&#114;&#99;&#104;.</td> 73 <td>Private slot to handle the end of the search.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td> 75 <td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td>
76 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#114;&#116; &#111;&#102; &#97; &#115;&#101;&#97;&#114;&#99;&#104;.</td> 76 <td>Private slot to handle the start of a search.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td> 78 <td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td>
79 <td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#101;v&#101;&#110;&#116;&#115;.</td> 79 <td>Protected method handling context menu events.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#HelpSearchWidget.eventFilter">eventFilter</a></td> 81 <td><a href="#HelpSearchWidget.eventFilter">eventFilter</a></td>
82 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#113;&#117;&#101;&#117;&#101;.</td> 82 <td>Public method called to filter the event queue.</td>
83 </tr><tr> 83 </tr><tr>
84 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td> 84 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td>
85 <td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;&#115;.</td> 85 <td>Protected method handling key press events.</td>
86 </tr> 86 </tr>
87 </table> 87 </table>
88 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a> 88 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a>
89 <h4>HelpSearchWidget (Constructor)</h4> 89 <h4>HelpSearchWidget (Constructor)</h4>
90 <b>HelpSearchWidget</b>(<i>engine, mainWindow, parent = None</i>) 90 <b>HelpSearchWidget</b>(<i>engine, mainWindow, parent = None</i>)
91 <p> 91 <p>
92 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 92 Constructor
93 </p><dl> 93 </p><dl>
94 <dt><i>engine</i></dt> 94 <dt><i>engine</i></dt>
95 <dd> 95 <dd>
96 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#115;&#101;&#97;&#114;&#99;&#104; &#101;&#110;&#103;&#105;&#110;&#101; (&#81;&#72;&#101;&#108;&#112;&#83;&#101;&#97;&#114;&#99;&#104;&#69;&#110;&#103;&#105;&#110;&#101;) 96 reference to the help search engine (QHelpSearchEngine)
97 </dd><dt><i>mainWindow</i></dt> 97 </dd><dt><i>mainWindow</i></dt>
98 <dd> 98 <dd>
99 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#97;&#105;&#110; w&#105;&#110;&#100;&#111;w &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#77;&#97;&#105;&#110;&#87;&#105;&#110;&#100;&#111;w) 99 reference to the main window object (QMainWindow)
100 </dd><dt><i>parent</i></dt> 100 </dd><dt><i>parent</i></dt>
101 <dd> 101 <dd>
102 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;) 102 reference to the parent widget (QWidget)
103 </dd> 103 </dd>
104 </dl><a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a> 104 </dl><a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a>
105 <h4>HelpSearchWidget.__search</h4> 105 <h4>HelpSearchWidget.__search</h4>
106 <b>__search</b>(<i></i>) 106 <b>__search</b>(<i></i>)
107 <p> 107 <p>
108 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#97; &#115;&#101;&#97;&#114;&#99;&#104; &#111;&#102; &#116;&#104;&#101; &#100;&#97;&#116;&#97;&#98;&#97;&#115;&#101;. 108 Private slot to perform a search of the database.
109 </p><a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a> 109 </p><a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a>
110 <h4>HelpSearchWidget.__searchingFinished</h4> 110 <h4>HelpSearchWidget.__searchingFinished</h4>
111 <b>__searchingFinished</b>(<i>hits</i>) 111 <b>__searchingFinished</b>(<i>hits</i>)
112 <p> 112 <p>
113 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#97;&#114;&#99;&#104;. 113 Private slot to handle the end of the search.
114 </p><dl> 114 </p><dl>
115 <dt><i>hits</i></dt> 115 <dt><i>hits</i></dt>
116 <dd> 116 <dd>
117 &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#104;&#105;&#116;&#115; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) (&#117;&#110;&#117;&#115;&#101;&#100;) 117 number of hits (integer) (unused)
118 </dd> 118 </dd>
119 </dl><a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a> 119 </dl><a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a>
120 <h4>HelpSearchWidget.__searchingStarted</h4> 120 <h4>HelpSearchWidget.__searchingStarted</h4>
121 <b>__searchingStarted</b>(<i></i>) 121 <b>__searchingStarted</b>(<i></i>)
122 <p> 122 <p>
123 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#116;&#97;&#114;&#116; &#111;&#102; &#97; &#115;&#101;&#97;&#114;&#99;&#104;. 123 Private slot to handle the start of a search.
124 </p><a NAME="HelpSearchWidget.contextMenuEvent" ID="HelpSearchWidget.contextMenuEvent"></a> 124 </p><a NAME="HelpSearchWidget.contextMenuEvent" ID="HelpSearchWidget.contextMenuEvent"></a>
125 <h4>HelpSearchWidget.contextMenuEvent</h4> 125 <h4>HelpSearchWidget.contextMenuEvent</h4>
126 <b>contextMenuEvent</b>(<i>evt</i>) 126 <b>contextMenuEvent</b>(<i>evt</i>)
127 <p> 127 <p>
128 &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#101;v&#101;&#110;&#116;&#115;. 128 Protected method handling context menu events.
129 </p><dl> 129 </p><dl>
130 <dt><i>evt</i></dt> 130 <dt><i>evt</i></dt>
131 <dd> 131 <dd>
132 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#109;&#101;&#110;&#117; &#101;v&#101;&#110;&#116; (&#81;&#67;&#111;&#110;&#116;&#101;x&#116;&#77;&#101;&#110;&#117;&#69;v&#101;&#110;&#116;) 132 reference to the context menu event (QContextMenuEvent)
133 </dd> 133 </dd>
134 </dl><a NAME="HelpSearchWidget.eventFilter" ID="HelpSearchWidget.eventFilter"></a> 134 </dl><a NAME="HelpSearchWidget.eventFilter" ID="HelpSearchWidget.eventFilter"></a>
135 <h4>HelpSearchWidget.eventFilter</h4> 135 <h4>HelpSearchWidget.eventFilter</h4>
136 <b>eventFilter</b>(<i>watched, event</i>) 136 <b>eventFilter</b>(<i>watched, event</i>)
137 <p> 137 <p>
138 &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#102;&#105;&#108;&#116;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#113;&#117;&#101;&#117;&#101;. 138 Public method called to filter the event queue.
139 </p><dl> 139 </p><dl>
140 <dt><i>watched</i></dt> 140 <dt><i>watched</i></dt>
141 <dd> 141 <dd>
142 &#116;&#104;&#101; &#81;&#79;&#98;&#106;&#101;&#99;&#116; &#98;&#101;&#105;&#110;&#103; w&#97;&#116;&#99;&#104;&#101;&#100; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;) 142 the QObject being watched (QObject)
143 </dd><dt><i>event</i></dt> 143 </dd><dt><i>event</i></dt>
144 <dd> 144 <dd>
145 &#116;&#104;&#101; &#101;v&#101;&#110;&#116; &#116;&#104;&#97;&#116; &#111;&#99;&#99;&#117;&#114;&#114;&#101;&#100; (&#81;&#69;v&#101;&#110;&#116;) 145 the event that occurred (QEvent)
146 </dd> 146 </dd>
147 </dl><dl> 147 </dl><dl>
148 <dt>Returns:</dt> 148 <dt>Returns:</dt>
149 <dd> 149 <dd>
150 &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; w&#104;&#101;&#116;&#104;&#101;&#114; &#116;&#104;&#101; &#101;v&#101;&#110;&#116; w&#97;&#115; &#104;&#97;&#110;&#100;&#108;&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;) 150 flag indicating whether the event was handled (boolean)
151 </dd> 151 </dd>
152 </dl><a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a> 152 </dl><a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a>
153 <h4>HelpSearchWidget.keyPressEvent</h4> 153 <h4>HelpSearchWidget.keyPressEvent</h4>
154 <b>keyPressEvent</b>(<i>evt</i>) 154 <b>keyPressEvent</b>(<i>evt</i>)
155 <p> 155 <p>
156 &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#109;&#101;&#116;&#104;&#111;&#100; &#104;&#97;&#110;&#100;&#108;&#105;&#110;&#103; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116;&#115;. 156 Protected method handling key press events.
157 </p><dl> 157 </p><dl>
158 <dt><i>evt</i></dt> 158 <dt><i>evt</i></dt>
159 <dd> 159 <dd>
160 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#107;&#101;y &#112;&#114;&#101;&#115;&#115; &#101;v&#101;&#110;&#116; (&#81;&#75;&#101;y&#69;v&#101;&#110;&#116;) 160 reference to the key press event (QKeyEvent)
161 </dd> 161 </dd>
162 </dl> 162 </dl>
163 <div align="right"><a href="#top">Up</a></div> 163 <div align="right"><a href="#top">Up</a></div>
164 <hr /> 164 <hr />
165 </body></html> 165 </body></html>

Mercurial Repository: eric

eric ide

mercurial