src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9236
db53a9efe7ef
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog</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.Plugins.WizardPlugins.DotDesktopWizard.DotDesktopListSelectionDialog</h1>
10
11 <p>
12 Module implementing a dialog to select multiple entries from a list.
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="#DotDesktopListSelectionDialog">DotDesktopListSelectionDialog</a></td>
25 <td>Class implementing a dialog to select multiple entries from a list.</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="DotDesktopListSelectionDialog" ID="DotDesktopListSelectionDialog"></a>
36 <h2>DotDesktopListSelectionDialog</h2>
37
38 <p>
39 Class implementing a dialog to select multiple entries from a list.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_DotDesktopListSelectionDialog
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="#DotDesktopListSelectionDialog.__init__">DotDesktopListSelectionDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#DotDesktopListSelectionDialog.getData">getData</a></td>
63 <td>Public method to extract the selected entries as a list or a string.</td>
64 </tr>
65 </table>
66 <h3>Static Methods</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71
72 <a NAME="DotDesktopListSelectionDialog.__init__" ID="DotDesktopListSelectionDialog.__init__"></a>
73 <h4>DotDesktopListSelectionDialog (Constructor)</h4>
74 <b>DotDesktopListSelectionDialog</b>(<i>entries, selectedEntries, separator, subEntries=None, allowMultiMain=True, allowMultiSub=True, parent=None</i>)
75
76 <p>
77 Constructor
78 </p>
79 <dl>
80
81 <dt><i>entries</i></dt>
82 <dd>
83 list of entries to be shown (list of string)
84 </dd>
85 <dt><i>selectedEntries</i></dt>
86 <dd>
87 list of entries to be selected (list of string
88 or string of entries separated by separator)
89 </dd>
90 <dt><i>separator</i></dt>
91 <dd>
92 separator string (string)
93 </dd>
94 <dt><i>subEntries</i></dt>
95 <dd>
96 secondary list of entries (list of string)
97 </dd>
98 <dt><i>allowMultiMain</i></dt>
99 <dd>
100 flag indicating to allow multiple selections for
101 the main entry (bool)
102 </dd>
103 <dt><i>allowMultiSub</i></dt>
104 <dd>
105 flag indicating to allow multiple selections for
106 the sub entry (bool)
107 </dd>
108 <dt><i>parent</i></dt>
109 <dd>
110 reference to the parent widget (QWidget)
111 </dd>
112 </dl>
113 <a NAME="DotDesktopListSelectionDialog.getData" ID="DotDesktopListSelectionDialog.getData"></a>
114 <h4>DotDesktopListSelectionDialog.getData</h4>
115 <b>getData</b>(<i>separator=None, separatorAtEnd=False</i>)
116
117 <p>
118 Public method to extract the selected entries as a list
119 or a string.
120 </p>
121 <dl>
122
123 <dt><i>separator</i></dt>
124 <dd>
125 separator string (string)
126 </dd>
127 <dt><i>separatorAtEnd</i></dt>
128 <dd>
129 flag indicating to append the separator (boolean)
130 </dd>
131 </dl>
132 <dl>
133 <dt>Return:</dt>
134 <dd>
135 list of selected entries (list of string) if the separator is
136 None or a string with entries delimited by separator (string)
137 </dd>
138 </dl>
139 <div align="right"><a href="#top">Up</a></div>
140 <hr />
141 </body></html>

eric ide

mercurial