src/eric7/Documentation/Source/eric7.Tasks.TaskPropertiesDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10431
64157aeb0312
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Tasks.TaskPropertiesDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Tasks.TaskPropertiesDialog</h1>
10
11 <p>
12 Module implementing the task properties dialog.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#TaskPropertiesDialog">TaskPropertiesDialog</a></td>
25 <td>Class implementing the task properties dialog.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="TaskPropertiesDialog" ID="TaskPropertiesDialog"></a>
36 <h2>TaskPropertiesDialog</h2>
37
38 <p>
39 Class implementing the task properties dialog.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_TaskPropertiesDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#TaskPropertiesDialog.__init__">TaskPropertiesDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#TaskPropertiesDialog.__setMode">__setMode</a></td>
63 <td>Private method to show or hide dialog elements depending on the task kind.</td>
64 </tr>
65 <tr>
66 <td><a href="#TaskPropertiesDialog.getData">getData</a></td>
67 <td>Public method to retrieve the dialogs data.</td>
68 </tr>
69 <tr>
70 <td><a href="#TaskPropertiesDialog.isManualTaskMode">isManualTaskMode</a></td>
71 <td>Public method to check, if the dialog is in manual task mode.</td>
72 </tr>
73 <tr>
74 <td><a href="#TaskPropertiesDialog.setSubTaskMode">setSubTaskMode</a></td>
75 <td>Public slot to set the sub-task mode.</td>
76 </tr>
77 </table>
78 <h3>Static Methods</h3>
79
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83
84 <a NAME="TaskPropertiesDialog.__init__" ID="TaskPropertiesDialog.__init__"></a>
85 <h4>TaskPropertiesDialog (Constructor)</h4>
86 <b>TaskPropertiesDialog</b>(<i>task=None, parent=None, projectOpen=False</i>)
87
88 <p>
89 Constructor
90 </p>
91 <dl>
92
93 <dt><i>task</i> (Task)</dt>
94 <dd>
95 the task object to be shown
96 </dd>
97 <dt><i>parent</i> (QWidget)</dt>
98 <dd>
99 the parent widget
100 </dd>
101 <dt><i>projectOpen</i> (bool)</dt>
102 <dd>
103 flag indicating status of the project
104 </dd>
105 </dl>
106 <a NAME="TaskPropertiesDialog.__setMode" ID="TaskPropertiesDialog.__setMode"></a>
107 <h4>TaskPropertiesDialog.__setMode</h4>
108 <b>__setMode</b>(<i>isFileTask, projectOpen</i>)
109
110 <p>
111 Private method to show or hide dialog elements depending on the task
112 kind.
113 </p>
114 <dl>
115
116 <dt><i>isFileTask</i> (bool)</dt>
117 <dd>
118 flag indicating a file task (i.e. extracted task)
119 </dd>
120 <dt><i>projectOpen</i> (bool)</dt>
121 <dd>
122 flag indicating status of the project
123 </dd>
124 </dl>
125 <a NAME="TaskPropertiesDialog.getData" ID="TaskPropertiesDialog.getData"></a>
126 <h4>TaskPropertiesDialog.getData</h4>
127 <b>getData</b>(<i></i>)
128
129 <p>
130 Public method to retrieve the dialogs data.
131 </p>
132 <dl>
133 <dt>Return:</dt>
134 <dd>
135 tuple of description, priority, type, completion flag,
136 project flag and long text
137 </dd>
138 </dl>
139 <dl>
140 <dt>Return Type:</dt>
141 <dd>
142 tuple of (str, TaskPriority, TaskType, bool, bool, str)
143 </dd>
144 </dl>
145 <a NAME="TaskPropertiesDialog.isManualTaskMode" ID="TaskPropertiesDialog.isManualTaskMode"></a>
146 <h4>TaskPropertiesDialog.isManualTaskMode</h4>
147 <b>isManualTaskMode</b>(<i></i>)
148
149 <p>
150 Public method to check, if the dialog is in manual task mode.
151 </p>
152 <dl>
153 <dt>Return:</dt>
154 <dd>
155 flag indicating manual task mode
156 </dd>
157 </dl>
158 <dl>
159 <dt>Return Type:</dt>
160 <dd>
161 bool
162 </dd>
163 </dl>
164 <a NAME="TaskPropertiesDialog.setSubTaskMode" ID="TaskPropertiesDialog.setSubTaskMode"></a>
165 <h4>TaskPropertiesDialog.setSubTaskMode</h4>
166 <b>setSubTaskMode</b>(<i>projectTask</i>)
167
168 <p>
169 Public slot to set the sub-task mode.
170 </p>
171 <dl>
172
173 <dt><i>projectTask</i></dt>
174 <dd>
175 flag indicating a project related task (boolean)
176 </dd>
177 </dl>
178 <div align="right"><a href="#top">Up</a></div>
179 <hr />
180 </body></html>

eric ide

mercurial