eric6/Documentation/Source/eric6.Project.AddDirectoryDialog.html

changeset 6942
2602857055c5
parent 5606
da305d172769
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Project.AddDirectoryDialog</h1>
23 <p>
24 Module implementing a dialog to add files of a directory to the project.
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="#AddDirectoryDialog">AddDirectoryDialog</a></td>
34 <td>Class implementing a dialog to add files of a directory to the project.</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="AddDirectoryDialog" ID="AddDirectoryDialog"></a>
43 <h2>AddDirectoryDialog</h2>
44 <p>
45 Class implementing a dialog to add files of a directory to the project.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_AddDirectoryDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#AddDirectoryDialog.getData">getData</a></td>
64 <td>Public slot to retrieve the dialogs data.</td>
65 </tr><tr>
66 <td><a href="#AddDirectoryDialog.on_filterComboBox_highlighted">on_filterComboBox_highlighted</a></td>
67 <td>Private slot to handle the selection of a file type.</td>
68 </tr><tr>
69 <td><a href="#AddDirectoryDialog.on_sourceDirPicker_textChanged">on_sourceDirPicker_textChanged</a></td>
70 <td>Private slot to handle the source directory text changed.</td>
71 </tr>
72 </table>
73 <h3>Static Methods</h3>
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a>
78 <h4>AddDirectoryDialog (Constructor)</h4>
79 <b>AddDirectoryDialog</b>(<i>pro, fileTypeFilter='source', parent=None, name=None, startdir=None</i>)
80 <p>
81 Constructor
82 </p><dl>
83 <dt><i>pro</i></dt>
84 <dd>
85 reference to the project object
86 </dd><dt><i>fileTypeFilter</i></dt>
87 <dd>
88 file type filter (string)
89 </dd><dt><i>parent</i></dt>
90 <dd>
91 parent widget of this dialog (QWidget)
92 </dd><dt><i>name</i></dt>
93 <dd>
94 name of this dialog (string)
95 </dd><dt><i>startdir</i></dt>
96 <dd>
97 start directory for the selection dialog
98 </dd>
99 </dl><a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a>
100 <h4>AddDirectoryDialog.getData</h4>
101 <b>getData</b>(<i></i>)
102 <p>
103 Public slot to retrieve the dialogs data.
104 </p><dl>
105 <dt>Returns:</dt>
106 <dd>
107 tuple of four values (string, string, string, boolean) giving
108 the selected file type, the source and target directory and
109 a flag indicating a recursive add
110 </dd>
111 </dl><a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a>
112 <h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4>
113 <b>on_filterComboBox_highlighted</b>(<i>fileType</i>)
114 <p>
115 Private slot to handle the selection of a file type.
116 </p><dl>
117 <dt><i>fileType</i></dt>
118 <dd>
119 the selected file type (string)
120 </dd>
121 </dl><a NAME="AddDirectoryDialog.on_sourceDirPicker_textChanged" ID="AddDirectoryDialog.on_sourceDirPicker_textChanged"></a>
122 <h4>AddDirectoryDialog.on_sourceDirPicker_textChanged</h4>
123 <b>on_sourceDirPicker_textChanged</b>(<i>directory</i>)
124 <p>
125 Private slot to handle the source directory text changed.
126 </p><p>
127 If the entered source directory is a subdirectory of the current
128 projects main directory, the target directory path is synchronized.
129 It is assumed, that the user wants to add a bunch of files to
130 the project in place.
131 </p><dl>
132 <dt><i>directory</i></dt>
133 <dd>
134 the text of the source directory line edit (string)
135 </dd>
136 </dl>
137 <div align="right"><a href="#top">Up</a></div>
138 <hr />
139 </body></html>

eric ide

mercurial