Documentation/Source/eric6.Project.AddFoundFilesDialog.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Project.AddFoundFilesDialog</h1>
23 <p>
24 Module implementing a dialog to show the found files to the user.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#AddFoundFilesDialog">AddFoundFilesDialog</a></td>
34 <td>Class implementing a dialog to show the found files to the user.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="AddFoundFilesDialog" ID="AddFoundFilesDialog"></a>
43 <h2>AddFoundFilesDialog</h2>
44 <p>
45 Class implementing a dialog to show the found files to the user.
46 </p><p>
47 The found files are displayed in a listview. Pressing the 'Add All' button
48 adds all files to the current project, the 'Add Selected' button adds only
49 the selected files and the 'Cancel' button cancels the operation.
50 </p>
51 <h3>Derived from</h3>
52 QDialog, Ui_AddFoundFilesDialog
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#AddFoundFilesDialog.__init__">AddFoundFilesDialog</a></td>
65 <td>Constructor</td>
66 </tr><tr>
67 <td><a href="#AddFoundFilesDialog.getSelection">getSelection</a></td>
68 <td>Public method to return the selected items.</td>
69 </tr><tr>
70 <td><a href="#AddFoundFilesDialog.on_addAllButton_clicked">on_addAllButton_clicked</a></td>
71 <td>Private slot to handle the 'Add All' button press.</td>
72 </tr><tr>
73 <td><a href="#AddFoundFilesDialog.on_addSelectedButton_clicked">on_addSelectedButton_clicked</a></td>
74 <td>Private slot to handle the 'Add Selected' button press.</td>
75 </tr><tr>
76 <td><a href="#AddFoundFilesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
77 <td>Private slot called by a button of the button box clicked.</td>
78 </tr>
79 </table>
80 <h3>Static Methods</h3>
81 <table>
82 <tr><td>None</td></tr>
83 </table>
84 <a NAME="AddFoundFilesDialog.__init__" ID="AddFoundFilesDialog.__init__"></a>
85 <h4>AddFoundFilesDialog (Constructor)</h4>
86 <b>AddFoundFilesDialog</b>(<i>files, parent=None, name=None</i>)
87 <p>
88 Constructor
89 </p><dl>
90 <dt><i>files</i></dt>
91 <dd>
92 list of files, that have been found for addition
93 (list of strings)
94 </dd><dt><i>parent</i></dt>
95 <dd>
96 parent widget of this dialog (QWidget)
97 </dd><dt><i>name</i></dt>
98 <dd>
99 name of this dialog (string)
100 </dd>
101 </dl><a NAME="AddFoundFilesDialog.getSelection" ID="AddFoundFilesDialog.getSelection"></a>
102 <h4>AddFoundFilesDialog.getSelection</h4>
103 <b>getSelection</b>(<i></i>)
104 <p>
105 Public method to return the selected items.
106 </p><dl>
107 <dt>Returns:</dt>
108 <dd>
109 list of selected files (list of strings)
110 </dd>
111 </dl><a NAME="AddFoundFilesDialog.on_addAllButton_clicked" ID="AddFoundFilesDialog.on_addAllButton_clicked"></a>
112 <h4>AddFoundFilesDialog.on_addAllButton_clicked</h4>
113 <b>on_addAllButton_clicked</b>(<i></i>)
114 <p>
115 Private slot to handle the 'Add All' button press.
116 </p><p>
117 Always returns the value 1 (integer).
118 </p><a NAME="AddFoundFilesDialog.on_addSelectedButton_clicked" ID="AddFoundFilesDialog.on_addSelectedButton_clicked"></a>
119 <h4>AddFoundFilesDialog.on_addSelectedButton_clicked</h4>
120 <b>on_addSelectedButton_clicked</b>(<i></i>)
121 <p>
122 Private slot to handle the 'Add Selected' button press.
123 </p><p>
124 Always returns the value 2 (integer).
125 </p><a NAME="AddFoundFilesDialog.on_buttonBox_clicked" ID="AddFoundFilesDialog.on_buttonBox_clicked"></a>
126 <h4>AddFoundFilesDialog.on_buttonBox_clicked</h4>
127 <b>on_buttonBox_clicked</b>(<i>button</i>)
128 <p>
129 Private slot called by a button of the button box clicked.
130 </p><dl>
131 <dt><i>button</i></dt>
132 <dd>
133 button that was clicked (QAbstractButton)
134 </dd>
135 </dl>
136 <div align="right"><a href="#top">Up</a></div>
137 <hr />
138 </body></html>

eric ide

mercurial