eric7/Documentation/Source/eric7.Project.AddFoundFilesDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.AddFoundFilesDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Project.AddFoundFilesDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the found files to the user.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#AddFoundFilesDialog">AddFoundFilesDialog</a></td>
39 <td>Class implementing a dialog to show the found files to the user.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="AddFoundFilesDialog" ID="AddFoundFilesDialog"></a>
50 <h2>AddFoundFilesDialog</h2>
51
52 <p>
53 Class implementing a dialog to show the found files to the user.
54 </p>
55 <p>
56 The found files are displayed in a listview. Pressing the 'Add All' button
57 adds all files to the current project, the 'Add Selected' button adds only
58 the selected files and the 'Cancel' button cancels the operation.
59 </p>
60 <h3>Derived from</h3>
61 QDialog, Ui_AddFoundFilesDialog
62 <h3>Class Attributes</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Class Methods</h3>
68
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <h3>Methods</h3>
73
74 <table>
75
76 <tr>
77 <td><a href="#AddFoundFilesDialog.__init__">AddFoundFilesDialog</a></td>
78 <td>Constructor</td>
79 </tr>
80 <tr>
81 <td><a href="#AddFoundFilesDialog.getSelection">getSelection</a></td>
82 <td>Public method to return the selected items.</td>
83 </tr>
84 <tr>
85 <td><a href="#AddFoundFilesDialog.on_addAllButton_clicked">on_addAllButton_clicked</a></td>
86 <td>Private slot to handle the 'Add All' button press.</td>
87 </tr>
88 <tr>
89 <td><a href="#AddFoundFilesDialog.on_addSelectedButton_clicked">on_addSelectedButton_clicked</a></td>
90 <td>Private slot to handle the 'Add Selected' button press.</td>
91 </tr>
92 <tr>
93 <td><a href="#AddFoundFilesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
94 <td>Private slot called by a button of the button box clicked.</td>
95 </tr>
96 </table>
97 <h3>Static Methods</h3>
98
99 <table>
100 <tr><td>None</td></tr>
101 </table>
102
103 <a NAME="AddFoundFilesDialog.__init__" ID="AddFoundFilesDialog.__init__"></a>
104 <h4>AddFoundFilesDialog (Constructor)</h4>
105 <b>AddFoundFilesDialog</b>(<i>files, parent=None, name=None</i>)
106
107 <p>
108 Constructor
109 </p>
110 <dl>
111
112 <dt><i>files</i></dt>
113 <dd>
114 list of files, that have been found for addition
115 (list of strings)
116 </dd>
117 <dt><i>parent</i></dt>
118 <dd>
119 parent widget of this dialog (QWidget)
120 </dd>
121 <dt><i>name</i></dt>
122 <dd>
123 name of this dialog (string)
124 </dd>
125 </dl>
126 <a NAME="AddFoundFilesDialog.getSelection" ID="AddFoundFilesDialog.getSelection"></a>
127 <h4>AddFoundFilesDialog.getSelection</h4>
128 <b>getSelection</b>(<i></i>)
129
130 <p>
131 Public method to return the selected items.
132 </p>
133 <dl>
134 <dt>Return:</dt>
135 <dd>
136 list of selected files (list of strings)
137 </dd>
138 </dl>
139 <a NAME="AddFoundFilesDialog.on_addAllButton_clicked" ID="AddFoundFilesDialog.on_addAllButton_clicked"></a>
140 <h4>AddFoundFilesDialog.on_addAllButton_clicked</h4>
141 <b>on_addAllButton_clicked</b>(<i></i>)
142
143 <p>
144 Private slot to handle the 'Add All' button press.
145 </p>
146 <p>
147 Always returns the value 1 (integer).
148 </p>
149 <a NAME="AddFoundFilesDialog.on_addSelectedButton_clicked" ID="AddFoundFilesDialog.on_addSelectedButton_clicked"></a>
150 <h4>AddFoundFilesDialog.on_addSelectedButton_clicked</h4>
151 <b>on_addSelectedButton_clicked</b>(<i></i>)
152
153 <p>
154 Private slot to handle the 'Add Selected' button press.
155 </p>
156 <p>
157 Always returns the value 2 (integer).
158 </p>
159 <a NAME="AddFoundFilesDialog.on_buttonBox_clicked" ID="AddFoundFilesDialog.on_buttonBox_clicked"></a>
160 <h4>AddFoundFilesDialog.on_buttonBox_clicked</h4>
161 <b>on_buttonBox_clicked</b>(<i>button</i>)
162
163 <p>
164 Private slot called by a button of the button box clicked.
165 </p>
166 <dl>
167
168 <dt><i>button</i></dt>
169 <dd>
170 button that was clicked (QAbstractButton)
171 </dd>
172 </dl>
173 <div align="right"><a href="#top">Up</a></div>
174 <hr />
175 </body></html>

eric ide

mercurial