~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric4.Project.AddDirectoryDialog.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>eric4.Project.AddDirectoryDialog</title>
 
6
<style>
 
7
body {
 
8
    background:white;
 
9
    margin: 0em 1em 10em 1em;
 
10
    color: black;
 
11
}
 
12
 
 
13
h1 { color: white; background: #4FA4FF; }
 
14
h2 { color: white; background: #4FA4FF; }
 
15
h3 { color: white; background: #00557F; }
 
16
h4 { color: white; background: #00557F; }
 
17
    
 
18
a { color: #AA5500; }
 
19
 
 
20
</style>
 
21
</head>
 
22
<body><a NAME="top" ID="top"></a>
 
23
<h1>eric4.Project.AddDirectoryDialog</h1>
 
24
<p>
 
25
Module implementing a dialog to add files of a directory to the project.
 
26
</p>
 
27
<h3>Classes</h3>
 
28
<table>
 
29
<tr>
 
30
<td><a href="#AddDirectoryDialog">AddDirectoryDialog</a></td>
 
31
<td>Class implementing a dialog to add files of a directory to the project.</td>
 
32
</tr>
 
33
</table>
 
34
<h3>Functions</h3>
 
35
<table>
 
36
<tr><td>None</td></tr>
 
37
</table>
 
38
<hr /><hr />
 
39
<a NAME="AddDirectoryDialog" ID="AddDirectoryDialog"></a>
 
40
<h2>AddDirectoryDialog</h2>
 
41
<p>
 
42
    Class implementing a dialog to add files of a directory to the project.
 
43
</p>
 
44
<h3>Derived from</h3>
 
45
QDialog, Ui_AddDirectoryDialog
 
46
<h3>Methods</h3>
 
47
<table>
 
48
<tr>
 
49
<td><a href="#AddDirectoryDialog.__init__">AddDirectoryDialog</a></td>
 
50
<td>Constructor</td>
 
51
</tr><tr>
 
52
<td><a href="#AddDirectoryDialog.__dirDialog">__dirDialog</a></td>
 
53
<td>Private slot to display a directory selection dialog.</td>
 
54
</tr><tr>
 
55
<td><a href="#AddDirectoryDialog.getData">getData</a></td>
 
56
<td>Public slot to retrieve the dialogs data.</td>
 
57
</tr><tr>
 
58
<td><a href="#AddDirectoryDialog.on_filterComboBox_highlighted">on_filterComboBox_highlighted</a></td>
 
59
<td>Private slot to handle the selection of a file type.</td>
 
60
</tr><tr>
 
61
<td><a href="#AddDirectoryDialog.on_sourceDirButton_clicked">on_sourceDirButton_clicked</a></td>
 
62
<td>Private slot to handle the source dir button press.</td>
 
63
</tr><tr>
 
64
<td><a href="#AddDirectoryDialog.on_sourceDirEdit_textChanged">on_sourceDirEdit_textChanged</a></td>
 
65
<td>Private slot to handle the source dir text changed.</td>
 
66
</tr><tr>
 
67
<td><a href="#AddDirectoryDialog.on_targetDirButton_clicked">on_targetDirButton_clicked</a></td>
 
68
<td>Private slot to handle the target dir button press.</td>
 
69
</tr>
 
70
</table>
 
71
<p><a NAME="AddDirectoryDialog.__init__" ID="AddDirectoryDialog.__init__"></a>
 
72
<h4>AddDirectoryDialog (Constructor)</h4>
 
73
<b>AddDirectoryDialog</b>(<i>pro, filter = 'source', parent = None, name = None, startdir = None</i>)
 
74
<p>
 
75
        Constructor
 
76
</p><dl>
 
77
<dt><i>pro</i></dt>
 
78
<dd>
 
79
reference to the project object
 
80
</dd><dt><i>filter</i></dt>
 
81
<dd>
 
82
file type filter (string or QString)
 
83
</dd><dt><i>parent</i></dt>
 
84
<dd>
 
85
parent widget of this dialog (QWidget)
 
86
</dd><dt><i>name</i></dt>
 
87
<dd>
 
88
name of this dialog (string or QString)
 
89
</dd><dt><i>startdir</i></dt>
 
90
<dd>
 
91
start directory for the selection dialog
 
92
</dd>
 
93
</dl><a NAME="AddDirectoryDialog.__dirDialog" ID="AddDirectoryDialog.__dirDialog"></a>
 
94
<h4>AddDirectoryDialog.__dirDialog</h4>
 
95
<b>__dirDialog</b>(<i>textEdit</i>)
 
96
<p>
 
97
        Private slot to display a directory selection dialog.
 
98
</p><dl>
 
99
<dt><i>textEdit</i></dt>
 
100
<dd>
 
101
field for the display of the selected directory name
 
102
                (QLineEdit)
 
103
</dd>
 
104
</dl><a NAME="AddDirectoryDialog.getData" ID="AddDirectoryDialog.getData"></a>
 
105
<h4>AddDirectoryDialog.getData</h4>
 
106
<b>getData</b>(<i></i>)
 
107
<p>
 
108
        Public slot to retrieve the dialogs data.
 
109
</p><dl>
 
110
<dt>Returns:</dt>
 
111
<dd>
 
112
tuple of four values (string, string, string, boolean) giving
 
113
            the selected file extension, the source and target directory and
 
114
            a flag indicating a recursive add
 
115
</dd>
 
116
</dl><a NAME="AddDirectoryDialog.on_filterComboBox_highlighted" ID="AddDirectoryDialog.on_filterComboBox_highlighted"></a>
 
117
<h4>AddDirectoryDialog.on_filterComboBox_highlighted</h4>
 
118
<b>on_filterComboBox_highlighted</b>(<i>fileType</i>)
 
119
<p>
 
120
        Private slot to handle the selection of a file type.
 
121
</p><dl>
 
122
<dt><i>fileType</i></dt>
 
123
<dd>
 
124
the selected file type (QString)
 
125
</dd>
 
126
</dl><a NAME="AddDirectoryDialog.on_sourceDirButton_clicked" ID="AddDirectoryDialog.on_sourceDirButton_clicked"></a>
 
127
<h4>AddDirectoryDialog.on_sourceDirButton_clicked</h4>
 
128
<b>on_sourceDirButton_clicked</b>(<i></i>)
 
129
<p>
 
130
        Private slot to handle the source dir button press.
 
131
</p><a NAME="AddDirectoryDialog.on_sourceDirEdit_textChanged" ID="AddDirectoryDialog.on_sourceDirEdit_textChanged"></a>
 
132
<h4>AddDirectoryDialog.on_sourceDirEdit_textChanged</h4>
 
133
<b>on_sourceDirEdit_textChanged</b>(<i>dir</i>)
 
134
<p>
 
135
        Private slot to handle the source dir text changed.
 
136
</p><p>
 
137
        If the entered source directory is a subdirectory of the current
 
138
        projects main directory, the target directory path is synchronized.
 
139
        It is assumed, that the user wants to add a bunch of files to
 
140
        the project in place.
 
141
</p><dl>
 
142
<dt><i>dir</i></dt>
 
143
<dd>
 
144
the text of the source directory line edit
 
145
</dd>
 
146
</dl><a NAME="AddDirectoryDialog.on_targetDirButton_clicked" ID="AddDirectoryDialog.on_targetDirButton_clicked"></a>
 
147
<h4>AddDirectoryDialog.on_targetDirButton_clicked</h4>
 
148
<b>on_targetDirButton_clicked</b>(<i></i>)
 
149
<p>
 
150
        Private slot to handle the target dir button press.
 
151
</p></p>
 
152
<div align="right"><a href="#top">Up</a></div>
 
153
<hr />
 
154
</body></html>
 
 
b'\\ No newline at end of file'