Mercurial Repositories > eric / file comparison

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

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

changeset 4918
71caf42a13d8
child 5038
df7103c3f2a6
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.QtHelp.HelpTocWidget</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.WebBrowser.QtHelp.HelpTocWidget</h1>
23 <p>
24 Module implementing a window for showing the QtHelp TOC.
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="#HelpTocWidget">HelpTocWidget</a></td>
34 <td>Class implementing a window for showing the QtHelp TOC.</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="HelpTocWidget" ID="HelpTocWidget"></a>
43 <h2>HelpTocWidget</h2>
44 <p>
45 Class implementing a window for showing the QtHelp TOC.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>escapePressed()</dt>
49 <dd>
50 emitted when the ESC key was pressed
51 </dd><dt>linkActivated(QUrl)</dt>
52 <dd>
53 emitted when a TOC entry is activated
54 </dd>
55 </dl>
56 <h3>Derived from</h3>
57 QWidget
58 <h3>Class Attributes</h3>
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Methods</h3>
67 <table>
68 <tr>
69 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#HelpTocWidget.__contentsCreated">__contentsCreated</a></td>
73 <td>Private slot to be run after the contents was generated.</td>
74 </tr><tr>
75 <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td>
76 <td>Private slot to expand the table of contents.</td>
77 </tr><tr>
78 <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td>
79 <td>Private slot showing the context menu.</td>
80 </tr><tr>
81 <td><a href="#HelpTocWidget.eventFilter">eventFilter</a></td>
82 <td>Public method called to filter the event queue.</td>
83 </tr><tr>
84 <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td>
85 <td>Public slot to expand the table of contents to a specific depth.</td>
86 </tr><tr>
87 <td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td>
88 <td>Protected method handling focus in events.</td>
89 </tr><tr>
90 <td><a href="#HelpTocWidget.itemClicked">itemClicked</a></td>
91 <td>Public slot handling a click of a TOC entry.</td>
92 </tr><tr>
93 <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td>
94 <td>Protected method handling key press events.</td>
95 </tr><tr>
96 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td>
97 <td>Public method to sync the TOC to the displayed page.</td>
98 </tr>
99 </table>
100 <h3>Static Methods</h3>
101 <table>
102 <tr><td>None</td></tr>
103 </table>
104 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a>
105 <h4>HelpTocWidget (Constructor)</h4>
106 <b>HelpTocWidget</b>(<i>engine, mainWindow, parent=None</i>)
107 <p>
108 Constructor
109 </p><dl>
110 <dt><i>engine</i></dt>
111 <dd>
112 reference to the help engine (QHelpEngine)
113 </dd><dt><i>mainWindow</i></dt>
114 <dd>
115 reference to the main window object (QMainWindow)
116 </dd><dt><i>parent</i></dt>
117 <dd>
118 reference to the parent widget (QWidget)
119 </dd>
120 </dl><a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a>
121 <h4>HelpTocWidget.__contentsCreated</h4>
122 <b>__contentsCreated</b>(<i></i>)
123 <p>
124 Private slot to be run after the contents was generated.
125 </p><a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a>
126 <h4>HelpTocWidget.__expandTOC</h4>
127 <b>__expandTOC</b>(<i></i>)
128 <p>
129 Private slot to expand the table of contents.
130 </p><a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a>
131 <h4>HelpTocWidget.__showContextMenu</h4>
132 <b>__showContextMenu</b>(<i>pos</i>)
133 <p>
134 Private slot showing the context menu.
135 </p><dl>
136 <dt><i>pos</i></dt>
137 <dd>
138 position to show the menu at (QPoint)
139 </dd>
140 </dl><a NAME="HelpTocWidget.eventFilter" ID="HelpTocWidget.eventFilter"></a>
141 <h4>HelpTocWidget.eventFilter</h4>
142 <b>eventFilter</b>(<i>watched, event</i>)
143 <p>
144 Public method called to filter the event queue.
145 </p><dl>
146 <dt><i>watched</i></dt>
147 <dd>
148 the QObject being watched (QObject)
149 </dd><dt><i>event</i></dt>
150 <dd>
151 the event that occurred (QEvent)
152 </dd>
153 </dl><dl>
154 <dt>Returns:</dt>
155 <dd>
156 flag indicating whether the event was handled (boolean)
157 </dd>
158 </dl><a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a>
159 <h4>HelpTocWidget.expandToDepth</h4>
160 <b>expandToDepth</b>(<i>depth</i>)
161 <p>
162 Public slot to expand the table of contents to a specific depth.
163 </p><dl>
164 <dt><i>depth</i></dt>
165 <dd>
166 depth to expand to (integer)
167 </dd>
168 </dl><a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a>
169 <h4>HelpTocWidget.focusInEvent</h4>
170 <b>focusInEvent</b>(<i>evt</i>)
171 <p>
172 Protected method handling focus in events.
173 </p><dl>
174 <dt><i>evt</i></dt>
175 <dd>
176 reference to the focus event object (QFocusEvent)
177 </dd>
178 </dl><a NAME="HelpTocWidget.itemClicked" ID="HelpTocWidget.itemClicked"></a>
179 <h4>HelpTocWidget.itemClicked</h4>
180 <b>itemClicked</b>(<i>index</i>)
181 <p>
182 Public slot handling a click of a TOC entry.
183 </p><dl>
184 <dt><i>index</i></dt>
185 <dd>
186 index of the TOC clicked (QModelIndex)
187 </dd>
188 </dl><a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a>
189 <h4>HelpTocWidget.keyPressEvent</h4>
190 <b>keyPressEvent</b>(<i>evt</i>)
191 <p>
192 Protected method handling key press events.
193 </p><dl>
194 <dt><i>evt</i></dt>
195 <dd>
196 reference to the key press event (QKeyEvent)
197 </dd>
198 </dl><a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a>
199 <h4>HelpTocWidget.syncToContent</h4>
200 <b>syncToContent</b>(<i>url</i>)
201 <p>
202 Public method to sync the TOC to the displayed page.
203 </p><dl>
204 <dt><i>url</i></dt>
205 <dd>
206 URL of the displayed page (QUrl)
207 </dd>
208 </dl><dl>
209 <dt>Returns:</dt>
210 <dd>
211 flag indicating a successful synchronization (boolean)
212 </dd>
213 </dl>
214 <div align="right"><a href="#top">Up</a></div>
215 <hr />
216 </body></html>

Mercurial Repository: eric

eric ide

mercurial