|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Preferences.ConfigurationPages.HelpDocumentationPage</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.Preferences.ConfigurationPages.HelpDocumentationPage</h1> |
|
23 <p> |
|
24 Module implementing the Help Documentation configuration page. |
|
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="#HelpDocumentationPage">HelpDocumentationPage</a></td> |
|
34 <td>Class implementing the Help Documentation configuration page.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr> |
|
40 <td><a href="#create">create</a></td> |
|
41 <td>Module function to create the configuration page.</td> |
|
42 </tr> |
|
43 </table> |
|
44 <hr /><hr /> |
|
45 <a NAME="HelpDocumentationPage" ID="HelpDocumentationPage"></a> |
|
46 <h2>HelpDocumentationPage</h2> |
|
47 <p> |
|
48 Class implementing the Help Documentation configuration page. |
|
49 </p> |
|
50 <h3>Derived from</h3> |
|
51 ConfigurationPageBase, Ui_HelpDocumentationPage |
|
52 <h3>Class Attributes</h3> |
|
53 <table> |
|
54 <tr><td>None</td></tr> |
|
55 </table> |
|
56 <h3>Class Methods</h3> |
|
57 <table> |
|
58 <tr><td>None</td></tr> |
|
59 </table> |
|
60 <h3>Methods</h3> |
|
61 <table> |
|
62 <tr> |
|
63 <td><a href="#HelpDocumentationPage.__init__">HelpDocumentationPage</a></td> |
|
64 <td>Constructor</td> |
|
65 </tr><tr> |
|
66 <td><a href="#HelpDocumentationPage.on_pyqt4DocDirButton_clicked">on_pyqt4DocDirButton_clicked</a></td> |
|
67 <td>Private slot to select the PyQt5 documentation directory.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#HelpDocumentationPage.on_pyqt5DocDirButton_clicked">on_pyqt5DocDirButton_clicked</a></td> |
|
70 <td>Private slot to select the PyQt5 documentation directory.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#HelpDocumentationPage.on_pysideDocDirButton_clicked">on_pysideDocDirButton_clicked</a></td> |
|
73 <td>Private slot to select the PySide documentation directory.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#HelpDocumentationPage.on_python2DocDirButton_clicked">on_python2DocDirButton_clicked</a></td> |
|
76 <td>Private slot to select the Python 2 documentation directory.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#HelpDocumentationPage.on_pythonDocDirButton_clicked">on_pythonDocDirButton_clicked</a></td> |
|
79 <td>Private slot to select the Python 3 documentation directory.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#HelpDocumentationPage.on_qt4DocDirButton_clicked">on_qt4DocDirButton_clicked</a></td> |
|
82 <td>Private slot to select the Qt4 documentation directory.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#HelpDocumentationPage.on_qt5DocDirButton_clicked">on_qt5DocDirButton_clicked</a></td> |
|
85 <td>Private slot to select the Qt5 documentation directory.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#HelpDocumentationPage.save">save</a></td> |
|
88 <td>Public slot to save the Help Documentation configuration.</td> |
|
89 </tr> |
|
90 </table> |
|
91 <h3>Static Methods</h3> |
|
92 <table> |
|
93 <tr><td>None</td></tr> |
|
94 </table> |
|
95 <a NAME="HelpDocumentationPage.__init__" ID="HelpDocumentationPage.__init__"></a> |
|
96 <h4>HelpDocumentationPage (Constructor)</h4> |
|
97 <b>HelpDocumentationPage</b>(<i></i>) |
|
98 <p> |
|
99 Constructor |
|
100 </p><a NAME="HelpDocumentationPage.on_pyqt4DocDirButton_clicked" ID="HelpDocumentationPage.on_pyqt4DocDirButton_clicked"></a> |
|
101 <h4>HelpDocumentationPage.on_pyqt4DocDirButton_clicked</h4> |
|
102 <b>on_pyqt4DocDirButton_clicked</b>(<i></i>) |
|
103 <p> |
|
104 Private slot to select the PyQt5 documentation directory. |
|
105 </p><a NAME="HelpDocumentationPage.on_pyqt5DocDirButton_clicked" ID="HelpDocumentationPage.on_pyqt5DocDirButton_clicked"></a> |
|
106 <h4>HelpDocumentationPage.on_pyqt5DocDirButton_clicked</h4> |
|
107 <b>on_pyqt5DocDirButton_clicked</b>(<i></i>) |
|
108 <p> |
|
109 Private slot to select the PyQt5 documentation directory. |
|
110 </p><a NAME="HelpDocumentationPage.on_pysideDocDirButton_clicked" ID="HelpDocumentationPage.on_pysideDocDirButton_clicked"></a> |
|
111 <h4>HelpDocumentationPage.on_pysideDocDirButton_clicked</h4> |
|
112 <b>on_pysideDocDirButton_clicked</b>(<i></i>) |
|
113 <p> |
|
114 Private slot to select the PySide documentation directory. |
|
115 </p><a NAME="HelpDocumentationPage.on_python2DocDirButton_clicked" ID="HelpDocumentationPage.on_python2DocDirButton_clicked"></a> |
|
116 <h4>HelpDocumentationPage.on_python2DocDirButton_clicked</h4> |
|
117 <b>on_python2DocDirButton_clicked</b>(<i></i>) |
|
118 <p> |
|
119 Private slot to select the Python 2 documentation directory. |
|
120 </p><a NAME="HelpDocumentationPage.on_pythonDocDirButton_clicked" ID="HelpDocumentationPage.on_pythonDocDirButton_clicked"></a> |
|
121 <h4>HelpDocumentationPage.on_pythonDocDirButton_clicked</h4> |
|
122 <b>on_pythonDocDirButton_clicked</b>(<i></i>) |
|
123 <p> |
|
124 Private slot to select the Python 3 documentation directory. |
|
125 </p><a NAME="HelpDocumentationPage.on_qt4DocDirButton_clicked" ID="HelpDocumentationPage.on_qt4DocDirButton_clicked"></a> |
|
126 <h4>HelpDocumentationPage.on_qt4DocDirButton_clicked</h4> |
|
127 <b>on_qt4DocDirButton_clicked</b>(<i></i>) |
|
128 <p> |
|
129 Private slot to select the Qt4 documentation directory. |
|
130 </p><a NAME="HelpDocumentationPage.on_qt5DocDirButton_clicked" ID="HelpDocumentationPage.on_qt5DocDirButton_clicked"></a> |
|
131 <h4>HelpDocumentationPage.on_qt5DocDirButton_clicked</h4> |
|
132 <b>on_qt5DocDirButton_clicked</b>(<i></i>) |
|
133 <p> |
|
134 Private slot to select the Qt5 documentation directory. |
|
135 </p><a NAME="HelpDocumentationPage.save" ID="HelpDocumentationPage.save"></a> |
|
136 <h4>HelpDocumentationPage.save</h4> |
|
137 <b>save</b>(<i></i>) |
|
138 <p> |
|
139 Public slot to save the Help Documentation configuration. |
|
140 </p> |
|
141 <div align="right"><a href="#top">Up</a></div> |
|
142 <hr /><hr /> |
|
143 <a NAME="create" ID="create"></a> |
|
144 <h2>create</h2> |
|
145 <b>create</b>(<i>dlg</i>) |
|
146 <p> |
|
147 Module function to create the configuration page. |
|
148 </p><dl> |
|
149 <dt><i>dlg</i></dt> |
|
150 <dd> |
|
151 reference to the configuration dialog |
|
152 </dd> |
|
153 </dl><dl> |
|
154 <dt>Returns:</dt> |
|
155 <dd> |
|
156 reference to the instantiated page (ConfigurationPageBase) |
|
157 </dd> |
|
158 </dl> |
|
159 <div align="right"><a href="#top">Up</a></div> |
|
160 <hr /> |
|
161 </body></html> |