eric7/Documentation/Source/eric7.WebBrowser.QtHelp.QtHelpDocumentationConfigurationDialog.html

branch
eric7
changeset 8422
bb5da74c1b3f
child 8596
d64760b2da50
equal deleted inserted replaced
8421:cd4eee7f1d28 8422:bb5da74c1b3f
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.QtHelp.QtHelpDocumentationConfigurationDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.QtHelp.QtHelpDocumentationConfigurationDialog</h1>
24
25 <p>
26 Module implementing a dialog to manage the QtHelp documentation database.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#QtHelpDocumentationConfigurationDialog">QtHelpDocumentationConfigurationDialog</a></td>
39 <td>Class implementing a dialog to manage the QtHelp documentation database.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="QtHelpDocumentationConfigurationDialog" ID="QtHelpDocumentationConfigurationDialog"></a>
50 <h2>QtHelpDocumentationConfigurationDialog</h2>
51
52 <p>
53 Class implementing a dialog to manage the QtHelp documentation database.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_QtHelpDocumentationConfigurationDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#QtHelpDocumentationConfigurationDialog.__init__">QtHelpDocumentationConfigurationDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#QtHelpDocumentationConfigurationDialog.__applyConfiguration">__applyConfiguration</a></td>
77 <td>Private method to apply the current QtHelp documentation configuration.</td>
78 </tr>
79 <tr>
80 <td><a href="#QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged">__documentationSettingsChanged</a></td>
81 <td>Private slot to handle a change of the QtHelp documentation configuration.</td>
82 </tr>
83 <tr>
84 <td><a href="#QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
85 <td>Private slot called by a button of the button box clicked.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93
94 <a NAME="QtHelpDocumentationConfigurationDialog.__init__" ID="QtHelpDocumentationConfigurationDialog.__init__"></a>
95 <h4>QtHelpDocumentationConfigurationDialog (Constructor)</h4>
96 <b>QtHelpDocumentationConfigurationDialog</b>(<i>engine, parent=None</i>)
97
98 <p>
99 Constructor
100 </p>
101 <dl>
102
103 <dt><i>engine</i> (QHelpEngineCore)</dt>
104 <dd>
105 reference to the Qt help engine
106 </dd>
107 <dt><i>parent</i> (QWidget (optional))</dt>
108 <dd>
109 reference to the parent widget (defaults to None)
110 </dd>
111 </dl>
112 <a NAME="QtHelpDocumentationConfigurationDialog.__applyConfiguration" ID="QtHelpDocumentationConfigurationDialog.__applyConfiguration"></a>
113 <h4>QtHelpDocumentationConfigurationDialog.__applyConfiguration</h4>
114 <b>__applyConfiguration</b>(<i></i>)
115
116 <p>
117 Private method to apply the current QtHelp documentation configuration.
118 </p>
119 <a NAME="QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged" ID="QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged"></a>
120 <h4>QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged</h4>
121 <b>__documentationSettingsChanged</b>(<i>settings</i>)
122
123 <p>
124 Private slot to handle a change of the QtHelp documentation
125 configuration.
126 </p>
127 <dl>
128
129 <dt><i>settings</i> (QtHelpDocumentationSettings)</dt>
130 <dd>
131 reference to the documentation settings object
132 </dd>
133 </dl>
134 <a NAME="QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked" ID="QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked"></a>
135 <h4>QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked</h4>
136 <b>on_buttonBox_clicked</b>(<i>button</i>)
137
138 <p>
139 Private slot called by a button of the button box clicked.
140 </p>
141 <dl>
142
143 <dt><i>button</i> (QAbstractButton)</dt>
144 <dd>
145 button that was clicked
146 </dd>
147 </dl>
148 <div align="right"><a href="#top">Up</a></div>
149 <hr />
150 </body></html>

eric ide

mercurial