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

branch
eric7
changeset 10479
856476537696
parent 10430
e440aaf179ce
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Project.AddFoundFilesDialog</h1> 9 <h1>eric7.Project.AddFoundFilesDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the found files to the user. 11 Module implementing a dialog to show the found files to the user.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#AddFoundFilesDialog">AddFoundFilesDialog</a></td> 22 <td><a href="#AddFoundFilesDialog">AddFoundFilesDialog</a></td>
25 <td>Class implementing a dialog to show the found files to the user.</td> 23 <td>Class implementing a dialog to show the found files to the user.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="AddFoundFilesDialog" ID="AddFoundFilesDialog"></a> 34 <a NAME="AddFoundFilesDialog" ID="AddFoundFilesDialog"></a>
36 <h2>AddFoundFilesDialog</h2> 35 <h2>AddFoundFilesDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to show the found files to the user. 37 Class implementing a dialog to show the found files to the user.
40 </p> 38 </p>
41 <p> 39 <p>
42 The found files are displayed in a listview. Pressing the 'Add All' button 40 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 41 adds all files to the current project, the 'Add Selected' button adds only
44 the selected files and the 'Cancel' button cancels the operation. 42 the selected files and the 'Cancel' button cancels the operation.
45 </p> 43 </p>
44
46 <h3>Derived from</h3> 45 <h3>Derived from</h3>
47 QDialog, Ui_AddFoundFilesDialog 46 QDialog, Ui_AddFoundFilesDialog
48 <h3>Class Attributes</h3> 47 <h3>Class Attributes</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Class Methods</h3> 52 <h3>Class Methods</h3>
54
55 <table> 53 <table>
56 <tr><td>None</td></tr> 54 <tr><td>None</td></tr>
57 </table> 55 </table>
56
58 <h3>Methods</h3> 57 <h3>Methods</h3>
59
60 <table> 58 <table>
61
62 <tr> 59 <tr>
63 <td><a href="#AddFoundFilesDialog.__init__">AddFoundFilesDialog</a></td> 60 <td><a href="#AddFoundFilesDialog.__init__">AddFoundFilesDialog</a></td>
64 <td>Constructor</td> 61 <td>Constructor</td>
65 </tr> 62 </tr>
66 <tr> 63 <tr>
78 <tr> 75 <tr>
79 <td><a href="#AddFoundFilesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 76 <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> 77 <td>Private slot called by a button of the button box clicked.</td>
81 </tr> 78 </tr>
82 </table> 79 </table>
80
83 <h3>Static Methods</h3> 81 <h3>Static Methods</h3>
84
85 <table> 82 <table>
86 <tr><td>None</td></tr> 83 <tr><td>None</td></tr>
87 </table> 84 </table>
88 85
86
89 <a NAME="AddFoundFilesDialog.__init__" ID="AddFoundFilesDialog.__init__"></a> 87 <a NAME="AddFoundFilesDialog.__init__" ID="AddFoundFilesDialog.__init__"></a>
90 <h4>AddFoundFilesDialog (Constructor)</h4> 88 <h4>AddFoundFilesDialog (Constructor)</h4>
91 <b>AddFoundFilesDialog</b>(<i>files, parent=None, name=None</i>) 89 <b>AddFoundFilesDialog</b>(<i>files, parent=None, name=None</i>)
92
93 <p> 90 <p>
94 Constructor 91 Constructor
95 </p> 92 </p>
93
96 <dl> 94 <dl>
97 95
98 <dt><i>files</i> (list of str)</dt> 96 <dt><i>files</i> (list of str)</dt>
99 <dd> 97 <dd>
100 list of files, that have been found for addition 98 list of files, that have been found for addition
109 </dd> 107 </dd>
110 </dl> 108 </dl>
111 <a NAME="AddFoundFilesDialog.getSelection" ID="AddFoundFilesDialog.getSelection"></a> 109 <a NAME="AddFoundFilesDialog.getSelection" ID="AddFoundFilesDialog.getSelection"></a>
112 <h4>AddFoundFilesDialog.getSelection</h4> 110 <h4>AddFoundFilesDialog.getSelection</h4>
113 <b>getSelection</b>(<i></i>) 111 <b>getSelection</b>(<i></i>)
114
115 <p> 112 <p>
116 Public method to return the selected items. 113 Public method to return the selected items.
117 </p> 114 </p>
115
118 <dl> 116 <dl>
119 <dt>Return:</dt> 117 <dt>Return:</dt>
120 <dd> 118 <dd>
121 list of selected files 119 list of selected files
122 </dd> 120 </dd>
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="AddFoundFilesDialog.on_addAllButton_clicked" ID="AddFoundFilesDialog.on_addAllButton_clicked"></a> 128 <a NAME="AddFoundFilesDialog.on_addAllButton_clicked" ID="AddFoundFilesDialog.on_addAllButton_clicked"></a>
131 <h4>AddFoundFilesDialog.on_addAllButton_clicked</h4> 129 <h4>AddFoundFilesDialog.on_addAllButton_clicked</h4>
132 <b>on_addAllButton_clicked</b>(<i></i>) 130 <b>on_addAllButton_clicked</b>(<i></i>)
133
134 <p> 131 <p>
135 Private slot to handle the 'Add All' button press. 132 Private slot to handle the 'Add All' button press.
136 </p> 133 </p>
137 <p> 134 <p>
138 Always returns the value 1 (integer). 135 Always returns the value 1 (integer).
139 </p> 136 </p>
137
140 <a NAME="AddFoundFilesDialog.on_addSelectedButton_clicked" ID="AddFoundFilesDialog.on_addSelectedButton_clicked"></a> 138 <a NAME="AddFoundFilesDialog.on_addSelectedButton_clicked" ID="AddFoundFilesDialog.on_addSelectedButton_clicked"></a>
141 <h4>AddFoundFilesDialog.on_addSelectedButton_clicked</h4> 139 <h4>AddFoundFilesDialog.on_addSelectedButton_clicked</h4>
142 <b>on_addSelectedButton_clicked</b>(<i></i>) 140 <b>on_addSelectedButton_clicked</b>(<i></i>)
143
144 <p> 141 <p>
145 Private slot to handle the 'Add Selected' button press. 142 Private slot to handle the 'Add Selected' button press.
146 </p> 143 </p>
147 <p> 144 <p>
148 Always returns the value 2 (integer). 145 Always returns the value 2 (integer).
149 </p> 146 </p>
147
150 <a NAME="AddFoundFilesDialog.on_buttonBox_clicked" ID="AddFoundFilesDialog.on_buttonBox_clicked"></a> 148 <a NAME="AddFoundFilesDialog.on_buttonBox_clicked" ID="AddFoundFilesDialog.on_buttonBox_clicked"></a>
151 <h4>AddFoundFilesDialog.on_buttonBox_clicked</h4> 149 <h4>AddFoundFilesDialog.on_buttonBox_clicked</h4>
152 <b>on_buttonBox_clicked</b>(<i>button</i>) 150 <b>on_buttonBox_clicked</b>(<i>button</i>)
153
154 <p> 151 <p>
155 Private slot called by a button of the button box clicked. 152 Private slot called by a button of the button box clicked.
156 </p> 153 </p>
154
157 <dl> 155 <dl>
158 156
159 <dt><i>button</i> (QAbstractButton)</dt> 157 <dt><i>button</i> (QAbstractButton)</dt>
160 <dd> 158 <dd>
161 button that was clicked 159 button that was clicked

eric ide

mercurial