71 <tr> |
71 <tr> |
72 <td><a href="#HelpTopicDialog.__init__">HelpTopicDialog</a></td> |
72 <td><a href="#HelpTopicDialog.__init__">HelpTopicDialog</a></td> |
73 <td>Constructor</td> |
73 <td>Constructor</td> |
74 </tr> |
74 </tr> |
75 <tr> |
75 <tr> |
76 <td><a href="#HelpTopicDialog.link">link</a></td> |
76 <td><a href="#HelpTopicDialog.document">document</a></td> |
77 <td>Public method to the link of the selected topic.</td> |
77 <td>Public method to retrieve the selected help topic.</td> |
78 </tr> |
78 </tr> |
79 </table> |
79 </table> |
80 <h3>Static Methods</h3> |
80 <h3>Static Methods</h3> |
81 |
81 |
82 <table> |
82 <table> |
83 <tr><td>None</td></tr> |
83 <tr><td>None</td></tr> |
84 </table> |
84 </table> |
85 |
85 |
86 <a NAME="HelpTopicDialog.__init__" ID="HelpTopicDialog.__init__"></a> |
86 <a NAME="HelpTopicDialog.__init__" ID="HelpTopicDialog.__init__"></a> |
87 <h4>HelpTopicDialog (Constructor)</h4> |
87 <h4>HelpTopicDialog (Constructor)</h4> |
88 <b>HelpTopicDialog</b>(<i>parent, keyword, links</i>) |
88 <b>HelpTopicDialog</b>(<i>parent, keyword, documents</i>) |
89 |
89 |
90 <p> |
90 <p> |
91 Constructor |
91 Constructor |
92 </p> |
92 </p> |
93 <dl> |
93 <dl> |
94 |
94 |
95 <dt><i>parent</i></dt> |
95 <dt><i>parent</i> (QWidget)</dt> |
96 <dd> |
96 <dd> |
97 reference to the parent widget (QWidget) |
97 reference to the parent widget |
98 </dd> |
98 </dd> |
99 <dt><i>keyword</i></dt> |
99 <dt><i>keyword</i> (str)</dt> |
100 <dd> |
100 <dd> |
101 keyword for the link set (string) |
101 keyword for the link set |
102 </dd> |
102 </dd> |
103 <dt><i>links</i></dt> |
103 <dt><i>documents</i> (list of QHelpLink)</dt> |
104 <dd> |
104 <dd> |
105 dictionary with help topic as key (string) and |
105 list of help document link data structures |
106 URL as value (QUrl) |
|
107 </dd> |
106 </dd> |
108 </dl> |
107 </dl> |
109 <a NAME="HelpTopicDialog.link" ID="HelpTopicDialog.link"></a> |
108 <a NAME="HelpTopicDialog.document" ID="HelpTopicDialog.document"></a> |
110 <h4>HelpTopicDialog.link</h4> |
109 <h4>HelpTopicDialog.document</h4> |
111 <b>link</b>(<i></i>) |
110 <b>document</b>(<i></i>) |
112 |
111 |
113 <p> |
112 <p> |
114 Public method to the link of the selected topic. |
113 Public method to retrieve the selected help topic. |
115 </p> |
114 </p> |
116 <dl> |
115 <dl> |
117 <dt>Return:</dt> |
116 <dt>Return:</dt> |
118 <dd> |
117 <dd> |
119 URL of the selected topic (QUrl) |
118 help document link for the selected help topic |
|
119 </dd> |
|
120 </dl> |
|
121 <dl> |
|
122 <dt>Return Type:</dt> |
|
123 <dd> |
|
124 QHelpLink |
120 </dd> |
125 </dd> |
121 </dl> |
126 </dl> |
122 <div align="right"><a href="#top">Up</a></div> |
127 <div align="right"><a href="#top">Up</a></div> |
123 <hr /> |
128 <hr /> |
124 </body></html> |
129 </body></html> |