src/eric7/Documentation/Source/eric7.QtHelpInterface.QtHelpDocumentationConfigurationDialog.html

branch
eric7
changeset 9686
2eee7a645cba
child 10479
856476537696
equal deleted inserted replaced
9685:b43e04854aba 9686:2eee7a645cba
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.QtHelpInterface.QtHelpDocumentationConfigurationDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QtHelpInterface.QtHelpDocumentationConfigurationDialog</h1>
10
11 <p>
12 Module implementing a dialog to manage the QtHelp documentation database.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#QtHelpDocumentationConfigurationDialog">QtHelpDocumentationConfigurationDialog</a></td>
25 <td>Class implementing a dialog to manage the QtHelp documentation database.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="QtHelpDocumentationConfigurationDialog" ID="QtHelpDocumentationConfigurationDialog"></a>
36 <h2>QtHelpDocumentationConfigurationDialog</h2>
37
38 <p>
39 Class implementing a dialog to manage the QtHelp documentation database.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_QtHelpDocumentationConfigurationDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#QtHelpDocumentationConfigurationDialog.__init__">QtHelpDocumentationConfigurationDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#QtHelpDocumentationConfigurationDialog.__applyConfiguration">__applyConfiguration</a></td>
63 <td>Private method to apply the current QtHelp documentation configuration.</td>
64 </tr>
65 <tr>
66 <td><a href="#QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged">__documentationSettingsChanged</a></td>
67 <td>Private slot to handle a change of the QtHelp documentation configuration.</td>
68 </tr>
69 <tr>
70 <td><a href="#QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
71 <td>Private slot called by a button of the button box clicked.</td>
72 </tr>
73 </table>
74 <h3>Static Methods</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79
80 <a NAME="QtHelpDocumentationConfigurationDialog.__init__" ID="QtHelpDocumentationConfigurationDialog.__init__"></a>
81 <h4>QtHelpDocumentationConfigurationDialog (Constructor)</h4>
82 <b>QtHelpDocumentationConfigurationDialog</b>(<i>engine, parent=None</i>)
83
84 <p>
85 Constructor
86 </p>
87 <dl>
88
89 <dt><i>engine</i> (QHelpEngineCore)</dt>
90 <dd>
91 reference to the Qt help engine
92 </dd>
93 <dt><i>parent</i> (QWidget (optional))</dt>
94 <dd>
95 reference to the parent widget (defaults to None)
96 </dd>
97 </dl>
98 <a NAME="QtHelpDocumentationConfigurationDialog.__applyConfiguration" ID="QtHelpDocumentationConfigurationDialog.__applyConfiguration"></a>
99 <h4>QtHelpDocumentationConfigurationDialog.__applyConfiguration</h4>
100 <b>__applyConfiguration</b>(<i></i>)
101
102 <p>
103 Private method to apply the current QtHelp documentation configuration.
104 </p>
105 <a NAME="QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged" ID="QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged"></a>
106 <h4>QtHelpDocumentationConfigurationDialog.__documentationSettingsChanged</h4>
107 <b>__documentationSettingsChanged</b>(<i>settings</i>)
108
109 <p>
110 Private slot to handle a change of the QtHelp documentation
111 configuration.
112 </p>
113 <dl>
114
115 <dt><i>settings</i> (QtHelpDocumentationSettings)</dt>
116 <dd>
117 reference to the documentation settings object
118 </dd>
119 </dl>
120 <a NAME="QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked" ID="QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked"></a>
121 <h4>QtHelpDocumentationConfigurationDialog.on_buttonBox_clicked</h4>
122 <b>on_buttonBox_clicked</b>(<i>button</i>)
123
124 <p>
125 Private slot called by a button of the button box clicked.
126 </p>
127 <dl>
128
129 <dt><i>button</i> (QAbstractButton)</dt>
130 <dd>
131 button that was clicked
132 </dd>
133 </dl>
134 <div align="right"><a href="#top">Up</a></div>
135 <hr />
136 </body></html>

eric ide

mercurial