eric7/Documentation/Source/eric7.Project.AddDirectoryDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.AddDirectoryDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Project.AddDirectoryDialog</h1>
24
25 <p>
26 Module implementing a dialog to add files of a directory to the project.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td>
39 <td>Class implementing a dialog to add files of a directory to the project.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a>
50 <h2>AddDirectoryDialog</h2>
51
52 <p>
53 Class implementing a dialog to add files of a directory to the project.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_AddDirectoryDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#AddDirectoryDialog.getData">getData</a></td>
77 <td>Public slot to retrieve the dialogs data.</td>
78 </tr>
79 <tr>
80 <td><a href="#AddDirectoryDialog.on_filterComboBox_highlighted">on_filterComboBox_highlighted</a></td>
81 <td>Private slot to handle the selection of a file type.</td>
82 </tr>
83 <tr>
84 <td><a href="#AddDirectoryDialog.on_sourceDirPicker_textChanged">on_sourceDirPicker_textChanged</a></td>
85 <td>Private slot to handle the source directory text changed.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93
94 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a>
95 <h4>AddDirectoryDialog (Constructor)</h4>
96 <b>AddDirectoryDialog</b>(<i>pro, fileTypeFilter='source', parent=None, name=None, startdir=None</i>)
97
98 <p>
99 Constructor
100 </p>
101 <dl>
102
103 <dt><i>pro</i></dt>
104 <dd>
105 reference to the project object
106 </dd>
107 <dt><i>fileTypeFilter</i></dt>
108 <dd>
109 file type filter (string)
110 </dd>
111 <dt><i>parent</i></dt>
112 <dd>
113 parent widget of this dialog (QWidget)
114 </dd>
115 <dt><i>name</i></dt>
116 <dd>
117 name of this dialog (string)
118 </dd>
119 <dt><i>startdir</i></dt>
120 <dd>
121 start directory for the selection dialog
122 </dd>
123 </dl>
124 <a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a>
125 <h4>AddDirectoryDialog.getData</h4>
126 <b>getData</b>(<i></i>)
127
128 <p>
129 Public slot to retrieve the dialogs data.
130 </p>
131 <dl>
132 <dt>Return:</dt>
133 <dd>
134 tuple of four values (string, string, string, boolean) giving
135 the selected file type, the source and target directory and
136 a flag indicating a recursive add
137 </dd>
138 </dl>
139 <a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a>
140 <h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4>
141 <b>on_filterComboBox_highlighted</b>(<i>index</i>)
142
143 <p>
144 Private slot to handle the selection of a file type.
145 </p>
146 <dl>
147
148 <dt><i>index</i> (int)</dt>
149 <dd>
150 index of the selected entry
151 </dd>
152 </dl>
153 <a NAME="AddDirectoryDialog.on_sourceDirPicker_textChanged" ID="AddDirectoryDialog.on_sourceDirPicker_textChanged"></a>
154 <h4>AddDirectoryDialog.on_sourceDirPicker_textChanged</h4>
155 <b>on_sourceDirPicker_textChanged</b>(<i>directory</i>)
156
157 <p>
158 Private slot to handle the source directory text changed.
159 </p>
160 <p>
161 If the entered source directory is a subdirectory of the current
162 projects main directory, the target directory path is synchronized.
163 It is assumed, that the user wants to add a bunch of files to
164 the project in place.
165 </p>
166 <dl>
167
168 <dt><i>directory</i></dt>
169 <dd>
170 the text of the source directory line edit (string)
171 </dd>
172 </dl>
173 <div align="right"><a href="#top">Up</a></div>
174 <hr />
175 </body></html>

eric ide

mercurial