|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Project.AddFileDialog</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Project.AddFileDialog</h1> |
|
12 <p> |
|
13 Module implementing a dialog to add a file to the project. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#AddFileDialog">AddFileDialog</a></td> |
|
23 <td>Class implementing a dialog to add a file to the project.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="AddFileDialog" ID="AddFileDialog"></a> |
|
32 <h2>AddFileDialog</h2> |
|
33 <p> |
|
34 Class implementing a dialog to add a file to the project. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QDialog, Ui_AddFileDialog |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#AddFileDialog.__init__">AddFileDialog</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#AddFileDialog.getData">getData</a></td> |
|
49 <td>Public slot to retrieve the dialogs data.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#AddFileDialog.on_sourceFileButton_clicked">on_sourceFileButton_clicked</a></td> |
|
52 <td>Private slot to display a file selection dialog.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#AddFileDialog.on_sourceFileEdit_textChanged">on_sourceFileEdit_textChanged</a></td> |
|
55 <td>Private slot to handle the source file text changed.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#AddFileDialog.on_targetDirButton_clicked">on_targetDirButton_clicked</a></td> |
|
58 <td>Private slot to display a directory selection dialog.</td> |
|
59 </tr> |
|
60 </table> |
|
61 <a NAME="AddFileDialog.__init__" ID="AddFileDialog.__init__"></a> |
|
62 <h4>AddFileDialog (Constructor)</h4> |
|
63 <b>AddFileDialog</b>(<i>pro, parent = None, filter = None, name = None, startdir = None</i>) |
|
64 <p> |
|
65 Constructor |
|
66 </p><dl> |
|
67 <dt><i>pro</i></dt> |
|
68 <dd> |
|
69 reference to the project object |
|
70 </dd><dt><i>parent</i></dt> |
|
71 <dd> |
|
72 parent widget of this dialog (QWidget) |
|
73 </dd><dt><i>filter</i></dt> |
|
74 <dd> |
|
75 filter specification for the file to add (string) |
|
76 </dd><dt><i>name</i></dt> |
|
77 <dd> |
|
78 name of this dialog (string) |
|
79 </dd><dt><i>startdir</i></dt> |
|
80 <dd> |
|
81 start directory for the selection dialog |
|
82 </dd> |
|
83 </dl><a NAME="AddFileDialog.getData" ID="AddFileDialog.getData"></a> |
|
84 <h4>AddFileDialog.getData</h4> |
|
85 <b>getData</b>(<i></i>) |
|
86 <p> |
|
87 Public slot to retrieve the dialogs data. |
|
88 </p><dl> |
|
89 <dt>Returns:</dt> |
|
90 <dd> |
|
91 tuple of three values (list of string, string, boolean) giving the |
|
92 source files, the target directory and a flag telling, whether |
|
93 the files shall be added as source code |
|
94 </dd> |
|
95 </dl><a NAME="AddFileDialog.on_sourceFileButton_clicked" ID="AddFileDialog.on_sourceFileButton_clicked"></a> |
|
96 <h4>AddFileDialog.on_sourceFileButton_clicked</h4> |
|
97 <b>on_sourceFileButton_clicked</b>(<i></i>) |
|
98 <p> |
|
99 Private slot to display a file selection dialog. |
|
100 </p><a NAME="AddFileDialog.on_sourceFileEdit_textChanged" ID="AddFileDialog.on_sourceFileEdit_textChanged"></a> |
|
101 <h4>AddFileDialog.on_sourceFileEdit_textChanged</h4> |
|
102 <b>on_sourceFileEdit_textChanged</b>(<i>sfile</i>) |
|
103 <p> |
|
104 Private slot to handle the source file text changed. |
|
105 </p><p> |
|
106 If the entered source directory is a subdirectory of the current |
|
107 projects main directory, the target directory path is synchronized. |
|
108 It is assumed, that the user wants to add a bunch of files to |
|
109 the project in place. |
|
110 </p><dl> |
|
111 <dt><i>sfile</i></dt> |
|
112 <dd> |
|
113 the text of the source file line edit (string) |
|
114 </dd> |
|
115 </dl><a NAME="AddFileDialog.on_targetDirButton_clicked" ID="AddFileDialog.on_targetDirButton_clicked"></a> |
|
116 <h4>AddFileDialog.on_targetDirButton_clicked</h4> |
|
117 <b>on_targetDirButton_clicked</b>(<i></i>) |
|
118 <p> |
|
119 Private slot to display a directory selection dialog. |
|
120 </p> |
|
121 <div align="right"><a href="#top">Up</a></div> |
|
122 <hr /> |
|
123 </body></html> |