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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10430
e440aaf179ce
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.AddFoundFilesDialog</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.Project.AddFoundFilesDialog</h1>
10
11 <p>
12 Module implementing a dialog to show the found files to the user.
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="#AddFoundFilesDialog">AddFoundFilesDialog</a></td>
25 <td>Class implementing a dialog to show the found files to the user.</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="AddFoundFilesDialog" ID="AddFoundFilesDialog"></a>
36 <h2>AddFoundFilesDialog</h2>
37
38 <p>
39 Class implementing a dialog to show the found files to the user.
40 </p>
41 <p>
42 The found files are displayed in a listview. Pressing the 'Add All' button
43 adds all files to the current project, the 'Add Selected' button adds only
44 the selected files and the 'Cancel' button cancels the operation.
45 </p>
46 <h3>Derived from</h3>
47 QDialog, Ui_AddFoundFilesDialog
48 <h3>Class Attributes</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59
60 <table>
61
62 <tr>
63 <td><a href="#AddFoundFilesDialog.__init__">AddFoundFilesDialog</a></td>
64 <td>Constructor</td>
65 </tr>
66 <tr>
67 <td><a href="#AddFoundFilesDialog.getSelection">getSelection</a></td>
68 <td>Public method to return the selected items.</td>
69 </tr>
70 <tr>
71 <td><a href="#AddFoundFilesDialog.on_addAllButton_clicked">on_addAllButton_clicked</a></td>
72 <td>Private slot to handle the 'Add All' button press.</td>
73 </tr>
74 <tr>
75 <td><a href="#AddFoundFilesDialog.on_addSelectedButton_clicked">on_addSelectedButton_clicked</a></td>
76 <td>Private slot to handle the 'Add Selected' button press.</td>
77 </tr>
78 <tr>
79 <td><a href="#AddFoundFilesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
80 <td>Private slot called by a button of the button box clicked.</td>
81 </tr>
82 </table>
83 <h3>Static Methods</h3>
84
85 <table>
86 <tr><td>None</td></tr>
87 </table>
88
89 <a NAME="AddFoundFilesDialog.__init__" ID="AddFoundFilesDialog.__init__"></a>
90 <h4>AddFoundFilesDialog (Constructor)</h4>
91 <b>AddFoundFilesDialog</b>(<i>files, parent=None, name=None</i>)
92
93 <p>
94 Constructor
95 </p>
96 <dl>
97
98 <dt><i>files</i></dt>
99 <dd>
100 list of files, that have been found for addition
101 (list of strings)
102 </dd>
103 <dt><i>parent</i></dt>
104 <dd>
105 parent widget of this dialog (QWidget)
106 </dd>
107 <dt><i>name</i></dt>
108 <dd>
109 name of this dialog (string)
110 </dd>
111 </dl>
112 <a NAME="AddFoundFilesDialog.getSelection" ID="AddFoundFilesDialog.getSelection"></a>
113 <h4>AddFoundFilesDialog.getSelection</h4>
114 <b>getSelection</b>(<i></i>)
115
116 <p>
117 Public method to return the selected items.
118 </p>
119 <dl>
120 <dt>Return:</dt>
121 <dd>
122 list of selected files (list of strings)
123 </dd>
124 </dl>
125 <a NAME="AddFoundFilesDialog.on_addAllButton_clicked" ID="AddFoundFilesDialog.on_addAllButton_clicked"></a>
126 <h4>AddFoundFilesDialog.on_addAllButton_clicked</h4>
127 <b>on_addAllButton_clicked</b>(<i></i>)
128
129 <p>
130 Private slot to handle the 'Add All' button press.
131 </p>
132 <p>
133 Always returns the value 1 (integer).
134 </p>
135 <a NAME="AddFoundFilesDialog.on_addSelectedButton_clicked" ID="AddFoundFilesDialog.on_addSelectedButton_clicked"></a>
136 <h4>AddFoundFilesDialog.on_addSelectedButton_clicked</h4>
137 <b>on_addSelectedButton_clicked</b>(<i></i>)
138
139 <p>
140 Private slot to handle the 'Add Selected' button press.
141 </p>
142 <p>
143 Always returns the value 2 (integer).
144 </p>
145 <a NAME="AddFoundFilesDialog.on_buttonBox_clicked" ID="AddFoundFilesDialog.on_buttonBox_clicked"></a>
146 <h4>AddFoundFilesDialog.on_buttonBox_clicked</h4>
147 <b>on_buttonBox_clicked</b>(<i>button</i>)
148
149 <p>
150 Private slot called by a button of the button box clicked.
151 </p>
152 <dl>
153
154 <dt><i>button</i></dt>
155 <dd>
156 button that was clicked (QAbstractButton)
157 </dd>
158 </dl>
159 <div align="right"><a href="#top">Up</a></div>
160 <hr />
161 </body></html>

eric ide

mercurial