Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html

changeset 5252
321c2003745d
parent 5038
df7103c3f2a6
child 5606
da305d172769
equal deleted inserted replaced
5250:2f22b20ea9ad 5252:321c2003745d
77 <table> 77 <table>
78 <tr> 78 <tr>
79 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> 79 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td>
80 <td>Constructor</td> 80 <td>Constructor</td>
81 </tr><tr> 81 </tr><tr>
82 <td><a href="#HelpIndexWidget.__activated">__activated</a></td>
83 <td>Private slot to handle the activation of a keyword entry.</td>
84 </tr><tr>
85 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> 82 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td>
86 <td>Private slot to enable the search edit.</td> 83 <td>Private slot to enable the search edit.</td>
87 </tr><tr> 84 </tr><tr>
88 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> 85 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
89 <td>Private slot to enable the search edit.</td> 86 <td>Private slot to enable the search edit.</td>
90 </tr><tr> 87 </tr><tr>
91 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> 88 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td>
92 <td>Private slot to filter the indices according to the given filter.</td> 89 <td>Private slot to filter the indices according to the given filter.</td>
90 </tr><tr>
91 <td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td>
92 <td>Private slot to handle the activation of a keyword entry.</td>
93 </tr><tr>
94 <td><a href="#HelpIndexWidget.__linksActivated">__linksActivated</a></td>
95 <td>Private slot to handle the activation of an entry with multiple links.</td>
93 </tr><tr> 96 </tr><tr>
94 <td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td> 97 <td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td>
95 <td>Private method to give the user a chance to select among the returned links.</td> 98 <td>Private method to give the user a chance to select among the returned links.</td>
96 </tr><tr> 99 </tr><tr>
97 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td> 100 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td>
118 <dd> 121 <dd>
119 reference to the help engine (QHelpEngine) 122 reference to the help engine (QHelpEngine)
120 </dd><dt><i>parent</i></dt> 123 </dd><dt><i>parent</i></dt>
121 <dd> 124 <dd>
122 reference to the parent widget (QWidget) 125 reference to the parent widget (QWidget)
123 </dd>
124 </dl><a NAME="HelpIndexWidget.__activated" ID="HelpIndexWidget.__activated"></a>
125 <h4>HelpIndexWidget.__activated</h4>
126 <b>__activated</b>(<i>idx, midButton=False</i>)
127 <p>
128 Private slot to handle the activation of a keyword entry.
129 </p><dl>
130 <dt><i>idx</i> (QModelIndex)</dt>
131 <dd>
132 index of the activated entry
133 </dd><dt><i>midButton</i> (bool)</dt>
134 <dd>
135 flag indicating a middle mouse button release
136 </dd> 126 </dd>
137 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> 127 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
138 <h4>HelpIndexWidget.__disableSearchEdit</h4> 128 <h4>HelpIndexWidget.__disableSearchEdit</h4>
139 <b>__disableSearchEdit</b>(<i></i>) 129 <b>__disableSearchEdit</b>(<i></i>)
140 <p> 130 <p>
152 </p><dl> 142 </p><dl>
153 <dt><i>filter</i></dt> 143 <dt><i>filter</i></dt>
154 <dd> 144 <dd>
155 filter to be used (string) 145 filter to be used (string)
156 </dd> 146 </dd>
147 </dl><a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a>
148 <h4>HelpIndexWidget.__linkActivated</h4>
149 <b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>)
150 <p>
151 Private slot to handle the activation of a keyword entry.
152 </p><dl>
153 <dt><i>url</i> (QUrl)</dt>
154 <dd>
155 URL of the selected entry
156 </dd><dt><i>keyword</i> (str)</dt>
157 <dd>
158 keyword for the URL
159 </dd><dt><i>modifiers=</i> (Qt.KeyboardModifiers or None)</dt>
160 <dd>
161 keyboard modifiers
162 </dd>
163 </dl><a NAME="HelpIndexWidget.__linksActivated" ID="HelpIndexWidget.__linksActivated"></a>
164 <h4>HelpIndexWidget.__linksActivated</h4>
165 <b>__linksActivated</b>(<i>links, keyword</i>)
166 <p>
167 Private slot to handle the activation of an entry with multiple links.
168 </p><dl>
169 <dt><i>links</i> (dict of key:str and value:QUrl)</dt>
170 <dd>
171 dictionary containing the links
172 </dd><dt><i>keyword</i> (str)</dt>
173 <dd>
174 keyword for the entry
175 </dd>
157 </dl><a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a> 176 </dl><a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a>
158 <h4>HelpIndexWidget.__selectLink</h4> 177 <h4>HelpIndexWidget.__selectLink</h4>
159 <b>__selectLink</b>(<i>links, keyword</i>) 178 <b>__selectLink</b>(<i>links, keyword</i>)
160 <p> 179 <p>
161 Private method to give the user a chance to select among the 180 Private method to give the user a chance to select among the

eric ide

mercurial