src/eric7/Documentation/Source/eric7.HelpViewer.HelpBookmarksImportDialog.html

Thu, 04 Jan 2024 18:02:25 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 04 Jan 2024 18:02:25 +0100
branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
permissions
-rw-r--r--

Fine tuned the source code documentation template and regenerated the source code documentation.

8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric7.HelpViewer.HelpBookmarksImportDialog</title>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <link rel="stylesheet" href="styles.css">
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 </head>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 <body>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 <a NAME="top" ID="top"></a>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 <h1>eric7.HelpViewer.HelpBookmarksImportDialog</h1>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 <p>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 Module implementing a dialog to enter the bookmarks import parameters.
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
13
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 <h3>Global Attributes</h3>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 <table>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 <tr><td>None</td></tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
18
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 <h3>Classes</h3>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 <table>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <td><a href="#HelpBookmarksImportDialog">HelpBookmarksImportDialog</a></td>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <td>Class implementing a dialog to enter the bookmarks import parameters.</td>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 </tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
26
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Functions</h3>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr><td>None</td></tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
31
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <hr />
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <hr />
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <a NAME="HelpBookmarksImportDialog" ID="HelpBookmarksImportDialog"></a>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <h2>HelpBookmarksImportDialog</h2>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <p>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 Class implementing a dialog to enter the bookmarks import parameters.
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
39
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <h3>Derived from</h3>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 QDialog, Ui_HelpBookmarksImportDialog
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <h3>Class Attributes</h3>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <table>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <tr><td>None</td></tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
46
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Class Methods</h3>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <table>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <tr><td>None</td></tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
51
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <h3>Methods</h3>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <table>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <td><a href="#HelpBookmarksImportDialog.__init__">HelpBookmarksImportDialog</a></td>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <td>Constructor</td>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 </tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <td><a href="#HelpBookmarksImportDialog.__updateOkButton">__updateOkButton</a></td>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td>Private method to update the state of the OK button.</td>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#HelpBookmarksImportDialog.getData">getData</a></td>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Public method to retrieve the entered data.</td>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
67
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <h3>Static Methods</h3>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <table>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <tr><td>None</td></tr>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 </table>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
73
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <a NAME="HelpBookmarksImportDialog.__init__" ID="HelpBookmarksImportDialog.__init__"></a>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <h4>HelpBookmarksImportDialog (Constructor)</h4>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <b>HelpBookmarksImportDialog</b>(<i>parent=None</i>)
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <p>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 Constructor
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
80
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <dl>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <dt><i>parent</i> (QWidget (optional))</dt>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <dd>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 reference to the parent widget (defaults to None)
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </dd>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 </dl>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <a NAME="HelpBookmarksImportDialog.__updateOkButton" ID="HelpBookmarksImportDialog.__updateOkButton"></a>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <h4>HelpBookmarksImportDialog.__updateOkButton</h4>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <b>__updateOkButton</b>(<i></i>)
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <p>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 Private method to update the state of the OK button.
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
94
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <a NAME="HelpBookmarksImportDialog.getData" ID="HelpBookmarksImportDialog.getData"></a>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <h4>HelpBookmarksImportDialog.getData</h4>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <b>getData</b>(<i></i>)
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <p>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 Public method to retrieve the entered data.
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 </p>
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
101
8905
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <dl>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <dt>Return:</dt>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <dd>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 tuple containing a flag indicating to replace the existing
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 bookmarks and the path of the bookmarks file to be imported
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 </dd>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 </dl>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <dl>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <dt>Return Type:</dt>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <dd>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 tuple of (bool, str)
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </dd>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 </dl>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <div align="right"><a href="#top">Up</a></div>
986278234c8a Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <hr />
10479
856476537696 Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 9209
diff changeset
117 </body></html>

eric ide

mercurial