Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpTocWidget.html

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.QtHelp.HelpTocWidget</h1> 23 <h1>eric6.WebBrowser.QtHelp.HelpTocWidget</h1>
24
23 <p> 25 <p>
24 Module implementing a window for showing the QtHelp TOC. 26 Module implementing a window for showing the QtHelp TOC.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#HelpTocWidget">HelpTocWidget</a></td> 38 <td><a href="#HelpTocWidget">HelpTocWidget</a></td>
34 <td>Class implementing a window for showing the QtHelp TOC.</td> 39 <td>Class implementing a window for showing the QtHelp TOC.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="HelpTocWidget" ID="HelpTocWidget"></a> 49 <a NAME="HelpTocWidget" ID="HelpTocWidget"></a>
43 <h2>HelpTocWidget</h2> 50 <h2>HelpTocWidget</h2>
51
44 <p> 52 <p>
45 Class implementing a window for showing the QtHelp TOC. 53 Class implementing a window for showing the QtHelp TOC.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>escapePressed()</dt> 58 <dt>escapePressed()</dt>
49 <dd> 59 <dd>
50 emitted when the ESC key was pressed 60 emitted when the ESC key was pressed
51 </dd><dt>newBackgroundTab(QUrl, str)</dt> 61 </dd>
62 <dt>newBackgroundTab(QUrl, str)</dt>
52 <dd> 63 <dd>
53 emitted to open an entry in a 64 emitted to open an entry in a
54 new background tab 65 new background tab
55 </dd><dt>newTab(QUrl, str)</dt> 66 </dd>
67 <dt>newTab(QUrl, str)</dt>
56 <dd> 68 <dd>
57 emitted to open an entry in a new tab 69 emitted to open an entry in a new tab
58 </dd><dt>newWindow(QUrl, str)</dt> 70 </dd>
71 <dt>newWindow(QUrl, str)</dt>
59 <dd> 72 <dd>
60 emitted to open an entry in a new window 73 emitted to open an entry in a new window
61 </dd><dt>openUrl(QUrl, str)</dt> 74 </dd>
75 <dt>openUrl(QUrl, str)</dt>
62 <dd> 76 <dd>
63 emitted to open an entry in the current tab 77 emitted to open an entry in the current tab
64 </dd> 78 </dd>
65 </dl> 79 </dl>
66 <h3>Derived from</h3> 80 <h3>Derived from</h3>
67 QWidget 81 QWidget
68 <h3>Class Attributes</h3> 82 <h3>Class Attributes</h3>
83
69 <table> 84 <table>
70 <tr><td>None</td></tr> 85 <tr><td>None</td></tr>
71 </table> 86 </table>
72 <h3>Class Methods</h3> 87 <h3>Class Methods</h3>
88
73 <table> 89 <table>
74 <tr><td>None</td></tr> 90 <tr><td>None</td></tr>
75 </table> 91 </table>
76 <h3>Methods</h3> 92 <h3>Methods</h3>
77 <table> 93
94 <table>
95
78 <tr> 96 <tr>
79 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td> 97 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td>
80 <td>Constructor</td> 98 <td>Constructor</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#HelpTocWidget.__contentsCreated">__contentsCreated</a></td> 101 <td><a href="#HelpTocWidget.__contentsCreated">__contentsCreated</a></td>
83 <td>Private slot to be run after the contents was generated.</td> 102 <td>Private slot to be run after the contents was generated.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td> 105 <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td>
86 <td>Private slot to expand the table of contents.</td> 106 <td>Private slot to expand the table of contents.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#HelpTocWidget.__linkActivated">__linkActivated</a></td> 109 <td><a href="#HelpTocWidget.__linkActivated">__linkActivated</a></td>
89 <td>Private slot handling the activation of an entry.</td> 110 <td>Private slot handling the activation of an entry.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td> 113 <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td>
92 <td>Private slot showing the context menu.</td> 114 <td>Private slot showing the context menu.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td> 117 <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td>
95 <td>Public slot to expand the table of contents to a specific depth.</td> 118 <td>Public slot to expand the table of contents to a specific depth.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td> 121 <td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td>
98 <td>Protected method handling focus in events.</td> 122 <td>Protected method handling focus in events.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td> 125 <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td>
101 <td>Protected method handling key press events.</td> 126 <td>Protected method handling key press events.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td> 129 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td>
104 <td>Public method to sync the TOC to the displayed page.</td> 130 <td>Public method to sync the TOC to the displayed page.</td>
105 </tr> 131 </tr>
106 </table> 132 </table>
107 <h3>Static Methods</h3> 133 <h3>Static Methods</h3>
108 <table> 134
109 <tr><td>None</td></tr> 135 <table>
110 </table> 136 <tr><td>None</td></tr>
137 </table>
138
111 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a> 139 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a>
112 <h4>HelpTocWidget (Constructor)</h4> 140 <h4>HelpTocWidget (Constructor)</h4>
113 <b>HelpTocWidget</b>(<i>engine, parent=None</i>) 141 <b>HelpTocWidget</b>(<i>engine, parent=None</i>)
142
114 <p> 143 <p>
115 Constructor 144 Constructor
116 </p><dl> 145 </p>
146 <dl>
147
117 <dt><i>engine</i></dt> 148 <dt><i>engine</i></dt>
118 <dd> 149 <dd>
119 reference to the help engine (QHelpEngine) 150 reference to the help engine (QHelpEngine)
120 </dd><dt><i>parent</i></dt> 151 </dd>
152 <dt><i>parent</i></dt>
121 <dd> 153 <dd>
122 reference to the parent widget (QWidget) 154 reference to the parent widget (QWidget)
123 </dd> 155 </dd>
124 </dl><a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a> 156 </dl>
157 <a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a>
125 <h4>HelpTocWidget.__contentsCreated</h4> 158 <h4>HelpTocWidget.__contentsCreated</h4>
126 <b>__contentsCreated</b>(<i></i>) 159 <b>__contentsCreated</b>(<i></i>)
160
127 <p> 161 <p>
128 Private slot to be run after the contents was generated. 162 Private slot to be run after the contents was generated.
129 </p><a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a> 163 </p>
164 <a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a>
130 <h4>HelpTocWidget.__expandTOC</h4> 165 <h4>HelpTocWidget.__expandTOC</h4>
131 <b>__expandTOC</b>(<i></i>) 166 <b>__expandTOC</b>(<i></i>)
167
132 <p> 168 <p>
133 Private slot to expand the table of contents. 169 Private slot to expand the table of contents.
134 </p><a NAME="HelpTocWidget.__linkActivated" ID="HelpTocWidget.__linkActivated"></a> 170 </p>
171 <a NAME="HelpTocWidget.__linkActivated" ID="HelpTocWidget.__linkActivated"></a>
135 <h4>HelpTocWidget.__linkActivated</h4> 172 <h4>HelpTocWidget.__linkActivated</h4>
136 <b>__linkActivated</b>(<i>url</i>) 173 <b>__linkActivated</b>(<i>url</i>)
174
137 <p> 175 <p>
138 Private slot handling the activation of an entry. 176 Private slot handling the activation of an entry.
139 </p><dl> 177 </p>
178 <dl>
179
140 <dt><i>url</i> (QUrl)</dt> 180 <dt><i>url</i> (QUrl)</dt>
141 <dd> 181 <dd>
142 URL of the activated entry 182 URL of the activated entry
143 </dd> 183 </dd>
144 </dl><a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a> 184 </dl>
185 <a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a>
145 <h4>HelpTocWidget.__showContextMenu</h4> 186 <h4>HelpTocWidget.__showContextMenu</h4>
146 <b>__showContextMenu</b>(<i>pos</i>) 187 <b>__showContextMenu</b>(<i>pos</i>)
188
147 <p> 189 <p>
148 Private slot showing the context menu. 190 Private slot showing the context menu.
149 </p><dl> 191 </p>
192 <dl>
193
150 <dt><i>pos</i></dt> 194 <dt><i>pos</i></dt>
151 <dd> 195 <dd>
152 position to show the menu at (QPoint) 196 position to show the menu at (QPoint)
153 </dd> 197 </dd>
154 </dl><a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a> 198 </dl>
199 <a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a>
155 <h4>HelpTocWidget.expandToDepth</h4> 200 <h4>HelpTocWidget.expandToDepth</h4>
156 <b>expandToDepth</b>(<i>depth</i>) 201 <b>expandToDepth</b>(<i>depth</i>)
202
157 <p> 203 <p>
158 Public slot to expand the table of contents to a specific depth. 204 Public slot to expand the table of contents to a specific depth.
159 </p><dl> 205 </p>
206 <dl>
207
160 <dt><i>depth</i></dt> 208 <dt><i>depth</i></dt>
161 <dd> 209 <dd>
162 depth to expand to (integer) 210 depth to expand to (integer)
163 </dd> 211 </dd>
164 </dl><a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a> 212 </dl>
213 <a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a>
165 <h4>HelpTocWidget.focusInEvent</h4> 214 <h4>HelpTocWidget.focusInEvent</h4>
166 <b>focusInEvent</b>(<i>evt</i>) 215 <b>focusInEvent</b>(<i>evt</i>)
216
167 <p> 217 <p>
168 Protected method handling focus in events. 218 Protected method handling focus in events.
169 </p><dl> 219 </p>
220 <dl>
221
170 <dt><i>evt</i></dt> 222 <dt><i>evt</i></dt>
171 <dd> 223 <dd>
172 reference to the focus event object (QFocusEvent) 224 reference to the focus event object (QFocusEvent)
173 </dd> 225 </dd>
174 </dl><a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a> 226 </dl>
227 <a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a>
175 <h4>HelpTocWidget.keyPressEvent</h4> 228 <h4>HelpTocWidget.keyPressEvent</h4>
176 <b>keyPressEvent</b>(<i>evt</i>) 229 <b>keyPressEvent</b>(<i>evt</i>)
230
177 <p> 231 <p>
178 Protected method handling key press events. 232 Protected method handling key press events.
179 </p><dl> 233 </p>
234 <dl>
235
180 <dt><i>evt</i></dt> 236 <dt><i>evt</i></dt>
181 <dd> 237 <dd>
182 reference to the key press event (QKeyEvent) 238 reference to the key press event (QKeyEvent)
183 </dd> 239 </dd>
184 </dl><a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a> 240 </dl>
241 <a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a>
185 <h4>HelpTocWidget.syncToContent</h4> 242 <h4>HelpTocWidget.syncToContent</h4>
186 <b>syncToContent</b>(<i>url</i>) 243 <b>syncToContent</b>(<i>url</i>)
244
187 <p> 245 <p>
188 Public method to sync the TOC to the displayed page. 246 Public method to sync the TOC to the displayed page.
189 </p><dl> 247 </p>
248 <dl>
249
190 <dt><i>url</i></dt> 250 <dt><i>url</i></dt>
191 <dd> 251 <dd>
192 URL of the displayed page (QUrl) 252 URL of the displayed page (QUrl)
193 </dd> 253 </dd>
194 </dl><dl> 254 </dl>
255 <dl>
195 <dt>Returns:</dt> 256 <dt>Returns:</dt>
196 <dd> 257 <dd>
197 flag indicating a successful synchronization (boolean) 258 flag indicating a successful synchronization (boolean)
198 </dd> 259 </dd>
199 </dl> 260 </dl>

Mercurial Repository: eric

eric ide

mercurial