|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Project.AddFoundFilesDialog</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Project.AddFoundFilesDialog</h1> |
|
12 <p> |
|
13 Module implementing a dialog to show the found files to the user. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#AddFoundFilesDialog">AddFoundFilesDialog</a></td> |
|
23 <td>Class implementing a dialog to show the found files to the user.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="AddFoundFilesDialog" ID="AddFoundFilesDialog"></a> |
|
32 <h2>AddFoundFilesDialog</h2> |
|
33 <p> |
|
34 Class implementing a dialog to show the found files to the user. |
|
35 </p><p> |
|
36 The found files are displayed in a listview. |
|
37 Pressing the 'Add All' button adds all files to the current project, |
|
38 the 'Add Selected' button adds only the selected files and the 'Cancel' |
|
39 button cancels the operation. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QDialog, Ui_AddFoundFilesDialog |
|
43 <h3>Class Attributes</h3> |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <h3>Methods</h3> |
|
48 <table> |
|
49 <tr> |
|
50 <td><a href="#AddFoundFilesDialog.__init__">AddFoundFilesDialog</a></td> |
|
51 <td>Constructor</td> |
|
52 </tr><tr> |
|
53 <td><a href="#AddFoundFilesDialog.getSelection">getSelection</a></td> |
|
54 <td>Public method to return the selected items.</td> |
|
55 </tr><tr> |
|
56 <td><a href="#AddFoundFilesDialog.on_addAllButton_clicked">on_addAllButton_clicked</a></td> |
|
57 <td>Private slot to handle the 'Add All' button press.</td> |
|
58 </tr><tr> |
|
59 <td><a href="#AddFoundFilesDialog.on_addSelectedButton_clicked">on_addSelectedButton_clicked</a></td> |
|
60 <td>Private slot to handle the 'Add Selected' button press.</td> |
|
61 </tr><tr> |
|
62 <td><a href="#AddFoundFilesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
63 <td>Private slot called by a button of the button box clicked.</td> |
|
64 </tr> |
|
65 </table> |
|
66 <a NAME="AddFoundFilesDialog.__init__" ID="AddFoundFilesDialog.__init__"></a> |
|
67 <h4>AddFoundFilesDialog (Constructor)</h4> |
|
68 <b>AddFoundFilesDialog</b>(<i>files, parent = None, name = None</i>) |
|
69 <p> |
|
70 Constructor |
|
71 </p><dl> |
|
72 <dt><i>files</i></dt> |
|
73 <dd> |
|
74 list of files, that have been found for addition (list of strings) |
|
75 </dd><dt><i>parent</i></dt> |
|
76 <dd> |
|
77 parent widget of this dialog (QWidget) |
|
78 </dd><dt><i>name</i></dt> |
|
79 <dd> |
|
80 name of this dialog (string) |
|
81 </dd> |
|
82 </dl><a NAME="AddFoundFilesDialog.getSelection" ID="AddFoundFilesDialog.getSelection"></a> |
|
83 <h4>AddFoundFilesDialog.getSelection</h4> |
|
84 <b>getSelection</b>(<i></i>) |
|
85 <p> |
|
86 Public method to return the selected items. |
|
87 </p><dl> |
|
88 <dt>Returns:</dt> |
|
89 <dd> |
|
90 list of selected files (list of strings) |
|
91 </dd> |
|
92 </dl><a NAME="AddFoundFilesDialog.on_addAllButton_clicked" ID="AddFoundFilesDialog.on_addAllButton_clicked"></a> |
|
93 <h4>AddFoundFilesDialog.on_addAllButton_clicked</h4> |
|
94 <b>on_addAllButton_clicked</b>(<i></i>) |
|
95 <p> |
|
96 Private slot to handle the 'Add All' button press. |
|
97 </p><dl> |
|
98 <dt>Returns:</dt> |
|
99 <dd> |
|
100 always 1 (int) |
|
101 </dd> |
|
102 </dl><a NAME="AddFoundFilesDialog.on_addSelectedButton_clicked" ID="AddFoundFilesDialog.on_addSelectedButton_clicked"></a> |
|
103 <h4>AddFoundFilesDialog.on_addSelectedButton_clicked</h4> |
|
104 <b>on_addSelectedButton_clicked</b>(<i></i>) |
|
105 <p> |
|
106 Private slot to handle the 'Add Selected' button press. |
|
107 </p><dl> |
|
108 <dt>Returns:</dt> |
|
109 <dd> |
|
110 always 2 (int) |
|
111 </dd> |
|
112 </dl><a NAME="AddFoundFilesDialog.on_buttonBox_clicked" ID="AddFoundFilesDialog.on_buttonBox_clicked"></a> |
|
113 <h4>AddFoundFilesDialog.on_buttonBox_clicked</h4> |
|
114 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
115 <p> |
|
116 Private slot called by a button of the button box clicked. |
|
117 </p><dl> |
|
118 <dt><i>button</i></dt> |
|
119 <dd> |
|
120 button that was clicked (QAbstractButton) |
|
121 </dd> |
|
122 </dl> |
|
123 <div align="right"><a href="#top">Up</a></div> |
|
124 <hr /> |
|
125 </body></html> |