Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.UI.Previewer.html

eric6/Documentation/Source/eric6.UI.Previewer.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7273
391d6b7b1eff
child 7318
5d39cd2d7960
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
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.UI.Previewer</h1> 23 <h1>eric6.UI.Previewer</h1>
24
23 <p> 25 <p>
24 Module implementing a previewer widget for HTML, Markdown and ReST files. 26 Module implementing a previewer widget for HTML, Markdown and ReST files.
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="#Previewer">Previewer</a></td> 38 <td><a href="#Previewer">Previewer</a></td>
34 <td>Class implementing a previewer widget containing a stack of specialized previewers.</td> 39 <td>Class implementing a previewer widget containing a stack of specialized previewers.</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="Previewer" ID="Previewer"></a> 49 <a NAME="Previewer" ID="Previewer"></a>
43 <h2>Previewer</h2> 50 <h2>Previewer</h2>
51
44 <p> 52 <p>
45 Class implementing a previewer widget containing a stack of 53 Class implementing a previewer widget containing a stack of
46 specialized previewers. 54 specialized previewers.
47 </p> 55 </p>
48 <h3>Derived from</h3> 56 <h3>Derived from</h3>
49 QStackedWidget 57 QStackedWidget
50 <h3>Class Attributes</h3> 58 <h3>Class Attributes</h3>
59
51 <table> 60 <table>
52 <tr><td>None</td></tr> 61 <tr><td>None</td></tr>
53 </table> 62 </table>
54 <h3>Class Methods</h3> 63 <h3>Class Methods</h3>
64
55 <table> 65 <table>
56 <tr><td>None</td></tr> 66 <tr><td>None</td></tr>
57 </table> 67 </table>
58 <h3>Methods</h3> 68 <h3>Methods</h3>
59 <table> 69
70 <table>
71
60 <tr> 72 <tr>
61 <td><a href="#Previewer.__init__">Previewer</a></td> 73 <td><a href="#Previewer.__init__">Previewer</a></td>
62 <td>Constructor</td> 74 <td>Constructor</td>
63 </tr><tr> 75 </tr>
76 <tr>
64 <td><a href="#Previewer.__editorChanged">__editorChanged</a></td> 77 <td><a href="#Previewer.__editorChanged">__editorChanged</a></td>
65 <td>Private slot to handle a change of the current editor.</td> 78 <td>Private slot to handle a change of the current editor.</td>
66 </tr><tr> 79 </tr>
80 <tr>
67 <td><a href="#Previewer.__editorLanguageChanged">__editorLanguageChanged</a></td> 81 <td><a href="#Previewer.__editorLanguageChanged">__editorLanguageChanged</a></td>
68 <td>Private slot to handle a change of the current editor's language.</td> 82 <td>Private slot to handle a change of the current editor's language.</td>
69 </tr><tr> 83 </tr>
84 <tr>
70 <td><a href="#Previewer.__editorTextChanged">__editorTextChanged</a></td> 85 <td><a href="#Previewer.__editorTextChanged">__editorTextChanged</a></td>
71 <td>Private slot to handle changes of an editor's text.</td> 86 <td>Private slot to handle changes of an editor's text.</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#Previewer.__isPreviewable">__isPreviewable</a></td> 89 <td><a href="#Previewer.__isPreviewable">__isPreviewable</a></td>
74 <td>Private method to check, if a preview can be shown for the given editor.</td> 90 <td>Private method to check, if a preview can be shown for the given editor.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#Previewer.__previewStateChanged">__previewStateChanged</a></td> 93 <td><a href="#Previewer.__previewStateChanged">__previewStateChanged</a></td>
77 <td>Private slot to toggle the display of the preview.</td> 94 <td>Private slot to toggle the display of the preview.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#Previewer.__processEditor">__processEditor</a></td> 97 <td><a href="#Previewer.__processEditor">__processEditor</a></td>
80 <td>Private slot to schedule the processing of the current editor's text.</td> 98 <td>Private slot to schedule the processing of the current editor's text.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#Previewer.__splitterMoved">__splitterMoved</a></td> 101 <td><a href="#Previewer.__splitterMoved">__splitterMoved</a></td>
83 <td>Private slot to handle the movement of the embedding splitter's handle.</td> 102 <td>Private slot to handle the movement of the embedding splitter's handle.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#Previewer.hide">hide</a></td> 105 <td><a href="#Previewer.hide">hide</a></td>
86 <td>Public method to hide the preview widget.</td> 106 <td>Public method to hide the preview widget.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#Previewer.show">show</a></td> 109 <td><a href="#Previewer.show">show</a></td>
89 <td>Public method to show the preview widget.</td> 110 <td>Public method to show the preview widget.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#Previewer.shutdown">shutdown</a></td> 113 <td><a href="#Previewer.shutdown">shutdown</a></td>
92 <td>Public method to perform shutdown actions.</td> 114 <td>Public method to perform shutdown actions.</td>
93 </tr> 115 </tr>
94 </table> 116 </table>
95 <h3>Static Methods</h3> 117 <h3>Static Methods</h3>
96 <table> 118
97 <tr><td>None</td></tr> 119 <table>
98 </table> 120 <tr><td>None</td></tr>
121 </table>
122
99 <a NAME="Previewer.__init__" ID="Previewer.__init__"></a> 123 <a NAME="Previewer.__init__" ID="Previewer.__init__"></a>
100 <h4>Previewer (Constructor)</h4> 124 <h4>Previewer (Constructor)</h4>
101 <b>Previewer</b>(<i>viewmanager, splitter, parent=None</i>) 125 <b>Previewer</b>(<i>viewmanager, splitter, parent=None</i>)
126
102 <p> 127 <p>
103 Constructor 128 Constructor
104 </p><dl> 129 </p>
130 <dl>
131
105 <dt><i>viewmanager</i></dt> 132 <dt><i>viewmanager</i></dt>
106 <dd> 133 <dd>
107 reference to the viewmanager object (ViewManager) 134 reference to the viewmanager object (ViewManager)
108 </dd><dt><i>splitter</i></dt> 135 </dd>
136 <dt><i>splitter</i></dt>
109 <dd> 137 <dd>
110 reference to the embedding splitter (QSplitter) 138 reference to the embedding splitter (QSplitter)
111 </dd><dt><i>parent</i></dt> 139 </dd>
140 <dt><i>parent</i></dt>
112 <dd> 141 <dd>
113 reference to the parent widget (QWidget) 142 reference to the parent widget (QWidget)
114 </dd> 143 </dd>
115 </dl><a NAME="Previewer.__editorChanged" ID="Previewer.__editorChanged"></a> 144 </dl>
145 <a NAME="Previewer.__editorChanged" ID="Previewer.__editorChanged"></a>
116 <h4>Previewer.__editorChanged</h4> 146 <h4>Previewer.__editorChanged</h4>
117 <b>__editorChanged</b>(<i>editor</i>) 147 <b>__editorChanged</b>(<i>editor</i>)
148
118 <p> 149 <p>
119 Private slot to handle a change of the current editor. 150 Private slot to handle a change of the current editor.
120 </p><dl> 151 </p>
152 <dl>
153
121 <dt><i>editor</i></dt> 154 <dt><i>editor</i></dt>
122 <dd> 155 <dd>
123 reference to the editor (Editor) 156 reference to the editor (Editor)
124 </dd> 157 </dd>
125 </dl><a NAME="Previewer.__editorLanguageChanged" ID="Previewer.__editorLanguageChanged"></a> 158 </dl>
159 <a NAME="Previewer.__editorLanguageChanged" ID="Previewer.__editorLanguageChanged"></a>
126 <h4>Previewer.__editorLanguageChanged</h4> 160 <h4>Previewer.__editorLanguageChanged</h4>
127 <b>__editorLanguageChanged</b>(<i>editor</i>) 161 <b>__editorLanguageChanged</b>(<i>editor</i>)
162
128 <p> 163 <p>
129 Private slot to handle a change of the current editor's language. 164 Private slot to handle a change of the current editor's language.
130 </p><dl> 165 </p>
166 <dl>
167
131 <dt><i>editor</i></dt> 168 <dt><i>editor</i></dt>
132 <dd> 169 <dd>
133 reference to the editor (Editor) 170 reference to the editor (Editor)
134 </dd> 171 </dd>
135 </dl><a NAME="Previewer.__editorTextChanged" ID="Previewer.__editorTextChanged"></a> 172 </dl>
173 <a NAME="Previewer.__editorTextChanged" ID="Previewer.__editorTextChanged"></a>
136 <h4>Previewer.__editorTextChanged</h4> 174 <h4>Previewer.__editorTextChanged</h4>
137 <b>__editorTextChanged</b>(<i>editor</i>) 175 <b>__editorTextChanged</b>(<i>editor</i>)
176
138 <p> 177 <p>
139 Private slot to handle changes of an editor's text. 178 Private slot to handle changes of an editor's text.
140 </p><dl> 179 </p>
180 <dl>
181
141 <dt><i>editor</i></dt> 182 <dt><i>editor</i></dt>
142 <dd> 183 <dd>
143 reference to the editor (Editor) 184 reference to the editor (Editor)
144 </dd> 185 </dd>
145 </dl><a NAME="Previewer.__isPreviewable" ID="Previewer.__isPreviewable"></a> 186 </dl>
187 <a NAME="Previewer.__isPreviewable" ID="Previewer.__isPreviewable"></a>
146 <h4>Previewer.__isPreviewable</h4> 188 <h4>Previewer.__isPreviewable</h4>
147 <b>__isPreviewable</b>(<i>editor</i>) 189 <b>__isPreviewable</b>(<i>editor</i>)
190
148 <p> 191 <p>
149 Private method to check, if a preview can be shown for the given 192 Private method to check, if a preview can be shown for the given
150 editor. 193 editor.
151 </p><dl> 194 </p>
195 <dl>
196
152 <dt><i>editor</i></dt> 197 <dt><i>editor</i></dt>
153 <dd> 198 <dd>
154 reference to an editor (Editor) 199 reference to an editor (Editor)
155 </dd> 200 </dd>
156 </dl><dl> 201 </dl>
202 <dl>
157 <dt>Returns:</dt> 203 <dt>Returns:</dt>
158 <dd> 204 <dd>
159 flag indicating if a preview can be shown (boolean) 205 flag indicating if a preview can be shown (boolean)
160 </dd> 206 </dd>
161 </dl><a NAME="Previewer.__previewStateChanged" ID="Previewer.__previewStateChanged"></a> 207 </dl>
208 <a NAME="Previewer.__previewStateChanged" ID="Previewer.__previewStateChanged"></a>
162 <h4>Previewer.__previewStateChanged</h4> 209 <h4>Previewer.__previewStateChanged</h4>
163 <b>__previewStateChanged</b>(<i>on</i>) 210 <b>__previewStateChanged</b>(<i>on</i>)
211
164 <p> 212 <p>
165 Private slot to toggle the display of the preview. 213 Private slot to toggle the display of the preview.
166 </p><dl> 214 </p>
215 <dl>
216
167 <dt><i>on</i></dt> 217 <dt><i>on</i></dt>
168 <dd> 218 <dd>
169 flag indicating to show a preview (boolean) 219 flag indicating to show a preview (boolean)
170 </dd> 220 </dd>
171 </dl><a NAME="Previewer.__processEditor" ID="Previewer.__processEditor"></a> 221 </dl>
222 <a NAME="Previewer.__processEditor" ID="Previewer.__processEditor"></a>
172 <h4>Previewer.__processEditor</h4> 223 <h4>Previewer.__processEditor</h4>
173 <b>__processEditor</b>(<i></i>) 224 <b>__processEditor</b>(<i></i>)
225
174 <p> 226 <p>
175 Private slot to schedule the processing of the current editor's text. 227 Private slot to schedule the processing of the current editor's text.
176 </p><a NAME="Previewer.__splitterMoved" ID="Previewer.__splitterMoved"></a> 228 </p>
229 <a NAME="Previewer.__splitterMoved" ID="Previewer.__splitterMoved"></a>
177 <h4>Previewer.__splitterMoved</h4> 230 <h4>Previewer.__splitterMoved</h4>
178 <b>__splitterMoved</b>(<i></i>) 231 <b>__splitterMoved</b>(<i></i>)
232
179 <p> 233 <p>
180 Private slot to handle the movement of the embedding splitter's handle. 234 Private slot to handle the movement of the embedding splitter's handle.
181 </p><a NAME="Previewer.hide" ID="Previewer.hide"></a> 235 </p>
236 <a NAME="Previewer.hide" ID="Previewer.hide"></a>
182 <h4>Previewer.hide</h4> 237 <h4>Previewer.hide</h4>
183 <b>hide</b>(<i></i>) 238 <b>hide</b>(<i></i>)
239
184 <p> 240 <p>
185 Public method to hide the preview widget. 241 Public method to hide the preview widget.
186 </p><a NAME="Previewer.show" ID="Previewer.show"></a> 242 </p>
243 <a NAME="Previewer.show" ID="Previewer.show"></a>
187 <h4>Previewer.show</h4> 244 <h4>Previewer.show</h4>
188 <b>show</b>(<i></i>) 245 <b>show</b>(<i></i>)
246
189 <p> 247 <p>
190 Public method to show the preview widget. 248 Public method to show the preview widget.
191 </p><a NAME="Previewer.shutdown" ID="Previewer.shutdown"></a> 249 </p>
250 <a NAME="Previewer.shutdown" ID="Previewer.shutdown"></a>
192 <h4>Previewer.shutdown</h4> 251 <h4>Previewer.shutdown</h4>
193 <b>shutdown</b>(<i></i>) 252 <b>shutdown</b>(<i></i>)
253
194 <p> 254 <p>
195 Public method to perform shutdown actions. 255 Public method to perform shutdown actions.
196 </p> 256 </p>
197 <div align="right"><a href="#top">Up</a></div> 257 <div align="right"><a href="#top">Up</a></div>
198 <hr /> 258 <hr />

Mercurial Repository: eric

eric ide

mercurial