Documentation/Source/eric5.Project.AddDirectoryDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Project.AddDirectoryDialog</h1> 23 <h1>eric5.Project.AddDirectoryDialog</h1>
24 <p> 24 <p>
25 &#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#97;&#100;&#100; &#102;&#105;&#108;&#101;&#115; &#111;&#102; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116;. 25 Module implementing a dialog to add files of a directory to the project.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td> 34 <td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td>
35 <td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#97;&#100;&#100; &#102;&#105;&#108;&#101;&#115; &#111;&#102; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.</td> 35 <td>Class implementing a dialog to add files of a directory to the project.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a> 43 <a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a>
44 <h2>AddDirectoryDialog</h2> 44 <h2>AddDirectoryDialog</h2>
45 <p> 45 <p>
46 &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#97;&#100;&#100; &#102;&#105;&#108;&#101;&#115; &#111;&#102; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116;. 46 Class implementing a dialog to add files of a directory to the project.
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 QDialog, Ui_AddDirectoryDialog 49 QDialog, Ui_AddDirectoryDialog
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td> 57 <td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td>
58 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#AddDirectoryDialog.__dirDialog">__dirDialog</a></td> 60 <td><a href="#AddDirectoryDialog.__dirDialog">__dirDialog</a></td>
61 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#105;&#115;&#112;&#108;&#97;y &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.</td> 61 <td>Private slot to display a directory selection dialog.</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#AddDirectoryDialog.getData">getData</a></td> 63 <td><a href="#AddDirectoryDialog.getData">getData</a></td>
64 <td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;&#115; &#100;&#97;&#116;&#97;.</td> 64 <td>Public slot to retrieve the dialogs data.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#AddDirectoryDialog.on_filterComboBox_highlighted">on_filterComboBox_highlighted</a></td> 66 <td><a href="#AddDirectoryDialog.on_filterComboBox_highlighted">on_filterComboBox_highlighted</a></td>
67 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#102;&#105;&#108;&#101; &#116;y&#112;&#101;.</td> 67 <td>Private slot to handle the selection of a file type.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#AddDirectoryDialog.on_sourceDirButton_clicked">on_sourceDirButton_clicked</a></td> 69 <td><a href="#AddDirectoryDialog.on_sourceDirButton_clicked">on_sourceDirButton_clicked</a></td>
70 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#100;&#105;&#114; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td> 70 <td>Private slot to handle the source dir button press.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#AddDirectoryDialog.on_sourceDirEdit_textChanged">on_sourceDirEdit_textChanged</a></td> 72 <td><a href="#AddDirectoryDialog.on_sourceDirEdit_textChanged">on_sourceDirEdit_textChanged</a></td>
73 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#100;&#105;&#114; &#116;&#101;x&#116; &#99;&#104;&#97;&#110;&#103;&#101;&#100;.</td> 73 <td>Private slot to handle the source dir text changed.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#AddDirectoryDialog.on_targetDirButton_clicked">on_targetDirButton_clicked</a></td> 75 <td><a href="#AddDirectoryDialog.on_targetDirButton_clicked">on_targetDirButton_clicked</a></td>
76 <td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#116;&#97;&#114;&#103;&#101;&#116; &#100;&#105;&#114; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td> 76 <td>Private slot to handle the target dir button press.</td>
77 </tr> 77 </tr>
78 </table> 78 </table>
79 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a> 79 <a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a>
80 <h4>AddDirectoryDialog (Constructor)</h4> 80 <h4>AddDirectoryDialog (Constructor)</h4>
81 <b>AddDirectoryDialog</b>(<i>pro, filter = 'source', parent = None, name = None, startdir = None</i>) 81 <b>AddDirectoryDialog</b>(<i>pro, filter = 'source', parent = None, name = None, startdir = None</i>)
82 <p> 82 <p>
83 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 83 Constructor
84 </p><dl> 84 </p><dl>
85 <dt><i>pro</i></dt> 85 <dt><i>pro</i></dt>
86 <dd> 86 <dd>
87 &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116; 87 reference to the project object
88 </dd><dt><i>filter</i></dt> 88 </dd><dt><i>filter</i></dt>
89 <dd> 89 <dd>
90 &#102;&#105;&#108;&#101; &#116;y&#112;&#101; &#102;&#105;&#108;&#116;&#101;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;) 90 file type filter (string)
91 </dd><dt><i>parent</i></dt> 91 </dd><dt><i>parent</i></dt>
92 <dd> 92 <dd>
93 &#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;) 93 parent widget of this dialog (QWidget)
94 </dd><dt><i>name</i></dt> 94 </dd><dt><i>name</i></dt>
95 <dd> 95 <dd>
96 &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;) 96 name of this dialog (string)
97 </dd><dt><i>startdir</i></dt> 97 </dd><dt><i>startdir</i></dt>
98 <dd> 98 <dd>
99 &#115;&#116;&#97;&#114;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#102;&#111;&#114; &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; 99 start directory for the selection dialog
100 </dd> 100 </dd>
101 </dl><a NAME="AddDirectoryDialog.__dirDialog" ID="AddDirectoryDialog.__dirDialog"></a> 101 </dl><a NAME="AddDirectoryDialog.__dirDialog" ID="AddDirectoryDialog.__dirDialog"></a>
102 <h4>AddDirectoryDialog.__dirDialog</h4> 102 <h4>AddDirectoryDialog.__dirDialog</h4>
103 <b>__dirDialog</b>(<i>textEdit</i>) 103 <b>__dirDialog</b>(<i>textEdit</i>)
104 <p> 104 <p>
105 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#105;&#115;&#112;&#108;&#97;y &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;. 105 Private slot to display a directory selection dialog.
106 </p><dl> 106 </p><dl>
107 <dt><i>textEdit</i></dt> 107 <dt><i>textEdit</i></dt>
108 <dd> 108 <dd>
109 &#102;&#105;&#101;&#108;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#110;&#97;&#109;&#101; 109 field for the display of the selected directory name
110 (&#81;&#76;&#105;&#110;&#101;&#69;&#100;&#105;&#116;) 110 (QLineEdit)
111 </dd> 111 </dd>
112 </dl><a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a> 112 </dl><a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a>
113 <h4>AddDirectoryDialog.getData</h4> 113 <h4>AddDirectoryDialog.getData</h4>
114 <b>getData</b>(<i></i>) 114 <b>getData</b>(<i></i>)
115 <p> 115 <p>
116 &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;&#115; &#100;&#97;&#116;&#97;. 116 Public slot to retrieve the dialogs data.
117 </p><dl> 117 </p><dl>
118 <dt>Returns:</dt> 118 <dt>Returns:</dt>
119 <dd> 119 <dd>
120 &#116;&#117;&#112;&#108;&#101; &#111;&#102; &#102;&#111;&#117;&#114; v&#97;&#108;&#117;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;, &#115;&#116;&#114;&#105;&#110;&#103;, &#115;&#116;&#114;&#105;&#110;&#103;, &#98;&#111;&#111;&#108;&#101;&#97;&#110;) &#103;&#105;v&#105;&#110;&#103; 120 tuple of four values (string, string, string, boolean) giving
121 &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#102;&#105;&#108;&#101; &#116;y&#112;&#101;, &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#97;&#110;&#100; &#116;&#97;&#114;&#103;&#101;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#97;&#110;&#100; 121 the selected file type, the source and target directory and
122 &#97; &#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#114;&#101;&#99;&#117;&#114;&#115;&#105;v&#101; &#97;&#100;&#100; 122 a flag indicating a recursive add
123 </dd> 123 </dd>
124 </dl><a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a> 124 </dl><a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a>
125 <h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4> 125 <h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4>
126 <b>on_filterComboBox_highlighted</b>(<i>fileType</i>) 126 <b>on_filterComboBox_highlighted</b>(<i>fileType</i>)
127 <p> 127 <p>
128 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#102;&#105;&#108;&#101; &#116;y&#112;&#101;. 128 Private slot to handle the selection of a file type.
129 </p><dl> 129 </p><dl>
130 <dt><i>fileType</i></dt> 130 <dt><i>fileType</i></dt>
131 <dd> 131 <dd>
132 &#116;&#104;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#102;&#105;&#108;&#101; &#116;y&#112;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;) 132 the selected file type (string)
133 </dd> 133 </dd>
134 </dl><a NAME="AddDirectoryDialog.on_sourceDirButton_clicked" ID="AddDirectoryDialog.on_sourceDirButton_clicked"></a> 134 </dl><a NAME="AddDirectoryDialog.on_sourceDirButton_clicked" ID="AddDirectoryDialog.on_sourceDirButton_clicked"></a>
135 <h4>AddDirectoryDialog.on_sourceDirButton_clicked</h4> 135 <h4>AddDirectoryDialog.on_sourceDirButton_clicked</h4>
136 <b>on_sourceDirButton_clicked</b>(<i></i>) 136 <b>on_sourceDirButton_clicked</b>(<i></i>)
137 <p> 137 <p>
138 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#100;&#105;&#114; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;. 138 Private slot to handle the source dir button press.
139 </p><a NAME="AddDirectoryDialog.on_sourceDirEdit_textChanged" ID="AddDirectoryDialog.on_sourceDirEdit_textChanged"></a> 139 </p><a NAME="AddDirectoryDialog.on_sourceDirEdit_textChanged" ID="AddDirectoryDialog.on_sourceDirEdit_textChanged"></a>
140 <h4>AddDirectoryDialog.on_sourceDirEdit_textChanged</h4> 140 <h4>AddDirectoryDialog.on_sourceDirEdit_textChanged</h4>
141 <b>on_sourceDirEdit_textChanged</b>(<i>dir</i>) 141 <b>on_sourceDirEdit_textChanged</b>(<i>dir</i>)
142 <p> 142 <p>
143 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#100;&#105;&#114; &#116;&#101;x&#116; &#99;&#104;&#97;&#110;&#103;&#101;&#100;. 143 Private slot to handle the source dir text changed.
144 </p><p> 144 </p><p>
145 &#73;&#102; &#116;&#104;&#101; &#101;&#110;&#116;&#101;&#114;&#101;&#100; &#115;&#111;&#117;&#114;&#99;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#105;&#115; &#97; &#115;&#117;&#98;&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#111;&#102; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; 145 If the entered source directory is a subdirectory of the current
146 &#112;&#114;&#111;&#106;&#101;&#99;&#116;&#115; &#109;&#97;&#105;&#110; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y, &#116;&#104;&#101; &#116;&#97;&#114;&#103;&#101;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#112;&#97;&#116;&#104; &#105;&#115; &#115;y&#110;&#99;&#104;&#114;&#111;&#110;&#105;z&#101;&#100;. 146 projects main directory, the target directory path is synchronized.
147 &#73;&#116; &#105;&#115; &#97;&#115;&#115;&#117;&#109;&#101;&#100;, &#116;&#104;&#97;&#116; &#116;&#104;&#101; &#117;&#115;&#101;&#114; w&#97;&#110;&#116;&#115; &#116;&#111; &#97;&#100;&#100; &#97; &#98;&#117;&#110;&#99;&#104; &#111;&#102; &#102;&#105;&#108;&#101;&#115; &#116;&#111; 147 It is assumed, that the user wants to add a bunch of files to
148 &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#105;&#110; &#112;&#108;&#97;&#99;&#101;. 148 the project in place.
149 </p><dl> 149 </p><dl>
150 <dt><i>dir</i></dt> 150 <dt><i>dir</i></dt>
151 <dd> 151 <dd>
152 &#116;&#104;&#101; &#116;&#101;x&#116; &#111;&#102; &#116;&#104;&#101; &#115;&#111;&#117;&#114;&#99;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#108;&#105;&#110;&#101; &#101;&#100;&#105;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;) 152 the text of the source directory line edit (string)
153 </dd> 153 </dd>
154 </dl><a NAME="AddDirectoryDialog.on_targetDirButton_clicked" ID="AddDirectoryDialog.on_targetDirButton_clicked"></a> 154 </dl><a NAME="AddDirectoryDialog.on_targetDirButton_clicked" ID="AddDirectoryDialog.on_targetDirButton_clicked"></a>
155 <h4>AddDirectoryDialog.on_targetDirButton_clicked</h4> 155 <h4>AddDirectoryDialog.on_targetDirButton_clicked</h4>
156 <b>on_targetDirButton_clicked</b>(<i></i>) 156 <b>on_targetDirButton_clicked</b>(<i></i>)
157 <p> 157 <p>
158 &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#116;&#97;&#114;&#103;&#101;&#116; &#100;&#105;&#114; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;. 158 Private slot to handle the target dir button press.
159 </p> 159 </p>
160 <div align="right"><a href="#top">Up</a></div> 160 <div align="right"><a href="#top">Up</a></div>
161 <hr /> 161 <hr />
162 </body></html> 162 </body></html>

eric ide

mercurial