|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.HelpViewer.HelpBookmarkPropertiesDialog</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.HelpViewer.HelpBookmarkPropertiesDialog</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a dialog to edit the bookmark properties. |
|
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="#HelpBookmarkPropertiesDialog">HelpBookmarkPropertiesDialog</a></td> |
|
25 <td>Class implementing a dialog to edit the bookmark properties.</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="HelpBookmarkPropertiesDialog" ID="HelpBookmarkPropertiesDialog"></a> |
|
36 <h2>HelpBookmarkPropertiesDialog</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a dialog to edit the bookmark properties. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QDialog, Ui_HelpBookmarkPropertiesDialog |
|
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="#HelpBookmarkPropertiesDialog.__init__">HelpBookmarkPropertiesDialog</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#HelpBookmarkPropertiesDialog.__updateOkButton">__updateOkButton</a></td> |
|
63 <td>Private method to set the enabled state of the OK button.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#HelpBookmarkPropertiesDialog.getData">getData</a></td> |
|
67 <td>Public method to retrieve the entered data.</td> |
|
68 </tr> |
|
69 </table> |
|
70 <h3>Static Methods</h3> |
|
71 |
|
72 <table> |
|
73 <tr><td>None</td></tr> |
|
74 </table> |
|
75 |
|
76 <a NAME="HelpBookmarkPropertiesDialog.__init__" ID="HelpBookmarkPropertiesDialog.__init__"></a> |
|
77 <h4>HelpBookmarkPropertiesDialog (Constructor)</h4> |
|
78 <b>HelpBookmarkPropertiesDialog</b>(<i>title="", url="", parent=None</i>) |
|
79 |
|
80 <p> |
|
81 Constructor |
|
82 </p> |
|
83 <dl> |
|
84 |
|
85 <dt><i>title</i> (str (optional))</dt> |
|
86 <dd> |
|
87 title for the bookmark (defaults to "") |
|
88 </dd> |
|
89 <dt><i>url</i> (str (optional))</dt> |
|
90 <dd> |
|
91 URL for the bookmark (defaults to "") |
|
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="HelpBookmarkPropertiesDialog.__updateOkButton" ID="HelpBookmarkPropertiesDialog.__updateOkButton"></a> |
|
99 <h4>HelpBookmarkPropertiesDialog.__updateOkButton</h4> |
|
100 <b>__updateOkButton</b>(<i></i>) |
|
101 |
|
102 <p> |
|
103 Private method to set the enabled state of the OK button. |
|
104 </p> |
|
105 <a NAME="HelpBookmarkPropertiesDialog.getData" ID="HelpBookmarkPropertiesDialog.getData"></a> |
|
106 <h4>HelpBookmarkPropertiesDialog.getData</h4> |
|
107 <b>getData</b>(<i></i>) |
|
108 |
|
109 <p> |
|
110 Public method to retrieve the entered data. |
|
111 </p> |
|
112 <dl> |
|
113 <dt>Return:</dt> |
|
114 <dd> |
|
115 tuple containing the title and URL for the bookmark |
|
116 </dd> |
|
117 </dl> |
|
118 <dl> |
|
119 <dt>Return Type:</dt> |
|
120 <dd> |
|
121 tuple of (str, str) |
|
122 </dd> |
|
123 </dl> |
|
124 <div align="right"><a href="#top">Up</a></div> |
|
125 <hr /> |
|
126 </body></html> |