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

branch
eric7
changeset 10479
856476537696
parent 9530
c30f02ea1b27
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.AddFileDialog</h1> 9 <h1>eric7.Project.AddFileDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to add a file to the project. 11 Module implementing a dialog to add a file to the project.
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="#AddFileDialog">AddFileDialog</a></td> 22 <td><a href="#AddFileDialog">AddFileDialog</a></td>
25 <td>Class implementing a dialog to add a file to the project.</td> 23 <td>Class implementing a dialog to add a file to the project.</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="AddFileDialog" ID="AddFileDialog"></a> 34 <a NAME="AddFileDialog" ID="AddFileDialog"></a>
36 <h2>AddFileDialog</h2> 35 <h2>AddFileDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to add a file to the project. 37 Class implementing a dialog to add a file to the project.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_AddFileDialog 41 QDialog, Ui_AddFileDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</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>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#AddFileDialog.__init__">AddFileDialog</a></td> 55 <td><a href="#AddFileDialog.__init__">AddFileDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
69 <tr> 66 <tr>
70 <td><a href="#AddFileDialog.on_sourceFilesPicker_textChanged">on_sourceFilesPicker_textChanged</a></td> 67 <td><a href="#AddFileDialog.on_sourceFilesPicker_textChanged">on_sourceFilesPicker_textChanged</a></td>
71 <td>Private slot to handle the source file text changed.</td> 68 <td>Private slot to handle the source file text changed.</td>
72 </tr> 69 </tr>
73 </table> 70 </table>
71
74 <h3>Static Methods</h3> 72 <h3>Static Methods</h3>
75
76 <table> 73 <table>
77 <tr><td>None</td></tr> 74 <tr><td>None</td></tr>
78 </table> 75 </table>
79 76
77
80 <a NAME="AddFileDialog.__init__" ID="AddFileDialog.__init__"></a> 78 <a NAME="AddFileDialog.__init__" ID="AddFileDialog.__init__"></a>
81 <h4>AddFileDialog (Constructor)</h4> 79 <h4>AddFileDialog (Constructor)</h4>
82 <b>AddFileDialog</b>(<i>pro, parent=None, fileTypeFilter=None, name=None, startdir=None</i>) 80 <b>AddFileDialog</b>(<i>pro, parent=None, fileTypeFilter=None, name=None, startdir=None</i>)
83
84 <p> 81 <p>
85 Constructor 82 Constructor
86 </p> 83 </p>
84
87 <dl> 85 <dl>
88 86
89 <dt><i>pro</i> (Project)</dt> 87 <dt><i>pro</i> (Project)</dt>
90 <dd> 88 <dd>
91 reference to the project object 89 reference to the project object
108 </dd> 106 </dd>
109 </dl> 107 </dl>
110 <a NAME="AddFileDialog.getData" ID="AddFileDialog.getData"></a> 108 <a NAME="AddFileDialog.getData" ID="AddFileDialog.getData"></a>
111 <h4>AddFileDialog.getData</h4> 109 <h4>AddFileDialog.getData</h4>
112 <b>getData</b>(<i></i>) 110 <b>getData</b>(<i></i>)
113
114 <p> 111 <p>
115 Public slot to retrieve the dialogs data. 112 Public slot to retrieve the dialogs data.
116 </p> 113 </p>
114
117 <dl> 115 <dl>
118 <dt>Return:</dt> 116 <dt>Return:</dt>
119 <dd> 117 <dd>
120 tuple containing the source files, the target directory and a flag 118 tuple containing the source files, the target directory and a flag
121 telling, whether the files shall be added as source code 119 telling, whether the files shall be added as source code
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog" ID="AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog"></a> 128 <a NAME="AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog" ID="AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog"></a>
131 <h4>AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog</h4> 129 <h4>AddFileDialog.on_sourceFilesPicker_aboutToShowPathPickerDialog</h4>
132 <b>on_sourceFilesPicker_aboutToShowPathPickerDialog</b>(<i></i>) 130 <b>on_sourceFilesPicker_aboutToShowPathPickerDialog</b>(<i></i>)
133
134 <p> 131 <p>
135 Private slot to perform actions before the source files selection 132 Private slot to perform actions before the source files selection
136 dialog is shown. 133 dialog is shown.
137 </p> 134 </p>
135
138 <a NAME="AddFileDialog.on_sourceFilesPicker_textChanged" ID="AddFileDialog.on_sourceFilesPicker_textChanged"></a> 136 <a NAME="AddFileDialog.on_sourceFilesPicker_textChanged" ID="AddFileDialog.on_sourceFilesPicker_textChanged"></a>
139 <h4>AddFileDialog.on_sourceFilesPicker_textChanged</h4> 137 <h4>AddFileDialog.on_sourceFilesPicker_textChanged</h4>
140 <b>on_sourceFilesPicker_textChanged</b>(<i>sfile</i>) 138 <b>on_sourceFilesPicker_textChanged</b>(<i>sfile</i>)
141
142 <p> 139 <p>
143 Private slot to handle the source file text changed. 140 Private slot to handle the source file text changed.
144 </p> 141 </p>
145 <p> 142 <p>
146 If the entered source directory is a subdirectory of the current 143 If the entered source directory is a subdirectory of the current
147 projects main directory, the target directory path is synchronized. 144 projects main directory, the target directory path is synchronized.
148 It is assumed, that the user wants to add a bunch of files to 145 It is assumed, that the user wants to add a bunch of files to
149 the project in place. 146 the project in place.
150 </p> 147 </p>
148
151 <dl> 149 <dl>
152 150
153 <dt><i>sfile</i> (str)</dt> 151 <dt><i>sfile</i> (str)</dt>
154 <dd> 152 <dd>
155 the text of the source file picker 153 the text of the source file picker

eric ide

mercurial