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

branch
eric7
changeset 10479
856476537696
parent 9686
2eee7a645cba
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QtHelpInterface.QtHelpDocumentationSelectionDialog</h1> 9 <h1>eric7.QtHelpInterface.QtHelpDocumentationSelectionDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to select QtHelp documentation sets to be 11 Module implementing a dialog to select QtHelp documentation sets to be
13 installed. 12 installed.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16
17 <table> 16 <table>
18 <tr><td>None</td></tr> 17 <tr><td>None</td></tr>
19 </table> 18 </table>
19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21
22 <table> 21 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#QtHelpDocumentationSelectionDialog">QtHelpDocumentationSelectionDialog</a></td> 23 <td><a href="#QtHelpDocumentationSelectionDialog">QtHelpDocumentationSelectionDialog</a></td>
26 <td>Class implementing a dialog to select QtHelp documentation sets to be installed.</td> 24 <td>Class implementing a dialog to select QtHelp documentation sets to be installed.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30
31 <table> 29 <table>
32 <tr><td>None</td></tr> 30 <tr><td>None</td></tr>
33 </table> 31 </table>
32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="QtHelpDocumentationSelectionDialog" ID="QtHelpDocumentationSelectionDialog"></a> 35 <a NAME="QtHelpDocumentationSelectionDialog" ID="QtHelpDocumentationSelectionDialog"></a>
37 <h2>QtHelpDocumentationSelectionDialog</h2> 36 <h2>QtHelpDocumentationSelectionDialog</h2>
38
39 <p> 37 <p>
40 Class implementing a dialog to select QtHelp documentation sets to be 38 Class implementing a dialog to select QtHelp documentation sets to be
41 installed. 39 installed.
42 </p> 40 </p>
41
43 <h3>Derived from</h3> 42 <h3>Derived from</h3>
44 QDialog, Ui_QtHelpDocumentationSelectionDialog 43 QDialog, Ui_QtHelpDocumentationSelectionDialog
45 <h3>Class Attributes</h3> 44 <h3>Class Attributes</h3>
45 <table>
46 <tr><td>AddMode</td></tr>
47 <tr><td>ManageMode</td></tr>
48 </table>
46 49
47 <table>
48 <tr><td>AddMode</td></tr><tr><td>ManageMode</td></tr>
49 </table>
50 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
51
52 <table> 51 <table>
53 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
54 </table> 53 </table>
54
55 <h3>Methods</h3> 55 <h3>Methods</h3>
56
57 <table> 56 <table>
58
59 <tr> 57 <tr>
60 <td><a href="#QtHelpDocumentationSelectionDialog.__init__">QtHelpDocumentationSelectionDialog</a></td> 58 <td><a href="#QtHelpDocumentationSelectionDialog.__init__">QtHelpDocumentationSelectionDialog</a></td>
61 <td>Constructor</td> 59 <td>Constructor</td>
62 </tr> 60 </tr>
63 <tr> 61 <tr>
83 <tr> 81 <tr>
84 <td><a href="#QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged">on_documentationList_itemSelectionChanged</a></td> 82 <td><a href="#QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged">on_documentationList_itemSelectionChanged</a></td>
85 <td>Private slot handling the selection of items.</td> 83 <td>Private slot handling the selection of items.</td>
86 </tr> 84 </tr>
87 </table> 85 </table>
86
88 <h3>Static Methods</h3> 87 <h3>Static Methods</h3>
89
90 <table> 88 <table>
91 <tr><td>None</td></tr> 89 <tr><td>None</td></tr>
92 </table> 90 </table>
93 91
92
94 <a NAME="QtHelpDocumentationSelectionDialog.__init__" ID="QtHelpDocumentationSelectionDialog.__init__"></a> 93 <a NAME="QtHelpDocumentationSelectionDialog.__init__" ID="QtHelpDocumentationSelectionDialog.__init__"></a>
95 <h4>QtHelpDocumentationSelectionDialog (Constructor)</h4> 94 <h4>QtHelpDocumentationSelectionDialog (Constructor)</h4>
96 <b>QtHelpDocumentationSelectionDialog</b>(<i>helpDocuments, mode, parent=None</i>) 95 <b>QtHelpDocumentationSelectionDialog</b>(<i>helpDocuments, mode, parent=None</i>)
97
98 <p> 96 <p>
99 Constructor 97 Constructor
100 </p> 98 </p>
99
101 <dl> 100 <dl>
102 101
103 <dt><i>helpDocuments</i> (dict of lists of str)</dt> 102 <dt><i>helpDocuments</i> (dict of lists of str)</dt>
104 <dd> 103 <dd>
105 dictionary containing the lists of help documents 104 dictionary containing the lists of help documents
115 </dd> 114 </dd>
116 </dl> 115 </dl>
117 <a NAME="QtHelpDocumentationSelectionDialog.__deleteCategory" ID="QtHelpDocumentationSelectionDialog.__deleteCategory"></a> 116 <a NAME="QtHelpDocumentationSelectionDialog.__deleteCategory" ID="QtHelpDocumentationSelectionDialog.__deleteCategory"></a>
118 <h4>QtHelpDocumentationSelectionDialog.__deleteCategory</h4> 117 <h4>QtHelpDocumentationSelectionDialog.__deleteCategory</h4>
119 <b>__deleteCategory</b>(<i>category</i>) 118 <b>__deleteCategory</b>(<i>category</i>)
120
121 <p> 119 <p>
122 Private method to delete a category. 120 Private method to delete a category.
123 </p> 121 </p>
122
124 <dl> 123 <dl>
125 124
126 <dt><i>category</i> (QTreeWidgetItem)</dt> 125 <dt><i>category</i> (QTreeWidgetItem)</dt>
127 <dd> 126 <dd>
128 reference to the category item 127 reference to the category item
129 </dd> 128 </dd>
130 </dl> 129 </dl>
131 <a NAME="QtHelpDocumentationSelectionDialog.getData" ID="QtHelpDocumentationSelectionDialog.getData"></a> 130 <a NAME="QtHelpDocumentationSelectionDialog.getData" ID="QtHelpDocumentationSelectionDialog.getData"></a>
132 <h4>QtHelpDocumentationSelectionDialog.getData</h4> 131 <h4>QtHelpDocumentationSelectionDialog.getData</h4>
133 <b>getData</b>(<i></i>) 132 <b>getData</b>(<i></i>)
134
135 <p> 133 <p>
136 Public method to retrieve the selected help documents. 134 Public method to retrieve the selected help documents.
137 </p> 135 </p>
136
138 <dl> 137 <dl>
139 <dt>Return:</dt> 138 <dt>Return:</dt>
140 <dd> 139 <dd>
141 list of QtHelp documentation sets to be installed 140 list of QtHelp documentation sets to be installed
142 </dd> 141 </dd>
148 </dd> 147 </dd>
149 </dl> 148 </dl>
150 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked"></a> 149 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked"></a>
151 <h4>QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked</h4> 150 <h4>QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked</h4>
152 <b>on_deleteAllButton_clicked</b>(<i></i>) 151 <b>on_deleteAllButton_clicked</b>(<i></i>)
153
154 <p> 152 <p>
155 Private slot to delete all documentation sets. 153 Private slot to delete all documentation sets.
156 </p> 154 </p>
155
157 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked"></a> 156 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked"></a>
158 <h4>QtHelpDocumentationSelectionDialog.on_deleteButton_clicked</h4> 157 <h4>QtHelpDocumentationSelectionDialog.on_deleteButton_clicked</h4>
159 <b>on_deleteButton_clicked</b>(<i></i>) 158 <b>on_deleteButton_clicked</b>(<i></i>)
160
161 <p> 159 <p>
162 Private slot to delete the selected documentation sets. 160 Private slot to delete the selected documentation sets.
163 </p> 161 </p>
162
164 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked"></a> 163 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked"></a>
165 <h4>QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked</h4> 164 <h4>QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked</h4>
166 <b>on_deleteCategoryButton_clicked</b>(<i></i>) 165 <b>on_deleteCategoryButton_clicked</b>(<i></i>)
167
168 <p> 166 <p>
169 Private slot to delete the selected documentation set categories. 167 Private slot to delete the selected documentation set categories.
170 </p> 168 </p>
169
171 <a NAME="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged" ID="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged"></a> 170 <a NAME="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged" ID="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged"></a>
172 <h4>QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged</h4> 171 <h4>QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged</h4>
173 <b>on_documentationList_itemSelectionChanged</b>(<i></i>) 172 <b>on_documentationList_itemSelectionChanged</b>(<i></i>)
174
175 <p> 173 <p>
176 Private slot handling the selection of items. 174 Private slot handling the selection of items.
177 </p> 175 </p>
176
178 <div align="right"><a href="#top">Up</a></div> 177 <div align="right"><a href="#top">Up</a></div>
179 <hr /> 178 <hr />
180 </body></html> 179 </body></html>

eric ide

mercurial