planner-doc 0.14.6-3ubuntu1 / usr / share / gtk-doc / html / libplanner / libplanner-mrp-property.html

This file is indexed.

/usr/share/gtk-doc/html/libplanner/libplanner-mrp-property.html is in planner-doc 0.14.6-3ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MrpProperty</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libplanner Reference Manual">
<link rel="up" href="ch01.html" title="Libplanner API">
<link rel="prev" href="libplanner-mrp-error.html" title="MrpError">
<link rel="next" href="libplanner-mrp-time.html" title="mrptime">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libplanner-mrp-error.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libplanner Reference Manual</th>
<td><a accesskey="n" href="libplanner-mrp-time.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libplanner-mrp-property.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libplanner-mrp-property.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libplanner-mrp-property"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libplanner-mrp-property.top_of_page"></a>MrpProperty</span></h2>
<p>MrpProperty — represents a custom property in the project.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libplanner-mrp-property.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libplanner/planner.h&gt;

typedef             <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty">MrpProperty</a>;
enum                <a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType">MrpPropertyType</a>;
<a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="returnvalue">MrpProperty</span></a> *       <a class="link" href="libplanner-mrp-property.html#mrp-property-new" title="mrp_property_new ()">mrp_property_new</a>                    (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType"><span class="type">MrpPropertyType</span></a> type</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> user_defined</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="libplanner-mrp-property.html#mrp-property-get-name" title="mrp_property_get_name ()">mrp_property_get_name</a>               (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);
<a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType"><span class="returnvalue">MrpPropertyType</span></a>     <a class="link" href="libplanner-mrp-property.html#mrp-property-get-property-type" title="mrp_property_get_property_type ()">mrp_property_get_property_type</a>      (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libplanner-mrp-property.html#mrp-property-set-label" title="mrp_property_set_label ()">mrp_property_set_label</a>              (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="libplanner-mrp-property.html#mrp-property-get-label" title="mrp_property_get_label ()">mrp_property_get_label</a>              (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libplanner-mrp-property.html#mrp-property-set-description" title="mrp_property_set_description ()">mrp_property_set_description</a>        (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="libplanner-mrp-property.html#mrp-property-get-description" title="mrp_property_get_description ()">mrp_property_get_description</a>        (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libplanner-mrp-property.html#mrp-property-set-user-defined" title="mrp_property_set_user_defined ()">mrp_property_set_user_defined</a>       (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> user_defined</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libplanner-mrp-property.html#mrp-property-get-user-defined" title="mrp_property_get_user_defined ()">mrp_property_get_user_defined</a>       (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);
<a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="returnvalue">MrpProperty</span></a> *       <a class="link" href="libplanner-mrp-property.html#mrp-property-ref" title="mrp_property_ref ()">mrp_property_ref</a>                    (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libplanner-mrp-property.html#mrp-property-unref" title="mrp_property_unref ()">mrp_property_unref</a>                  (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="libplanner-mrp-property.html#mrp-property-type-as-string" title="mrp_property_type_as_string ()">mrp_property_type_as_string</a>         (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType"><span class="type">MrpPropertyType</span></a> type</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libplanner-mrp-property.description"></a><h2>Description</h2>
<p>
MrpProperty is a typedef to <span class="type">GParamSpec</span>. It is used to add properties to
projects, resources and tasks in run time, for example by the user of a
GUI application, or plugins that add functionality.
</p>
</div>
<div class="refsect1">
<a name="libplanner-mrp-property.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MrpProperty"></a><h3>MrpProperty</h3>
<pre class="programlisting">typedef GParamSpec MrpProperty;
</pre>
<p>
Object representing a custom property in the project.
</p>
</div>
<hr>
<div class="refsect2">
<a name="MrpPropertyType"></a><h3>enum MrpPropertyType</h3>
<pre class="programlisting">typedef enum {
	MRP_PROPERTY_TYPE_NONE,
	MRP_PROPERTY_TYPE_INT,
	MRP_PROPERTY_TYPE_FLOAT,
	MRP_PROPERTY_TYPE_STRING,
	MRP_PROPERTY_TYPE_STRING_LIST,
	MRP_PROPERTY_TYPE_DATE,
	MRP_PROPERTY_TYPE_DURATION,
	MRP_PROPERTY_TYPE_COST
} MrpPropertyType;
</pre>
<p>
The different types of custom properties. Cost and duration are simply
float and integer values, but the extra information provided makes it
possible to format the values properly in a GUI.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="MRP-PROPERTY-TYPE-NONE:CAPS"></a><span class="term"><code class="literal">MRP_PROPERTY_TYPE_NONE</code></span></p></td>
<td>invalid (unset type)
</td>
</tr>
<tr>
<td><p><a name="MRP-PROPERTY-TYPE-INT:CAPS"></a><span class="term"><code class="literal">MRP_PROPERTY_TYPE_INT</code></span></p></td>
<td>integer type
</td>
</tr>
<tr>
<td><p><a name="MRP-PROPERTY-TYPE-FLOAT:CAPS"></a><span class="term"><code class="literal">MRP_PROPERTY_TYPE_FLOAT</code></span></p></td>
<td>float type
</td>
</tr>
<tr>
<td><p><a name="MRP-PROPERTY-TYPE-STRING:CAPS"></a><span class="term"><code class="literal">MRP_PROPERTY_TYPE_STRING</code></span></p></td>
<td>string type
</td>
</tr>
<tr>
<td><p><a name="MRP-PROPERTY-TYPE-STRING-LIST:CAPS"></a><span class="term"><code class="literal">MRP_PROPERTY_TYPE_STRING_LIST</code></span></p></td>
<td>not implemented
</td>
</tr>
<tr>
<td><p><a name="MRP-PROPERTY-TYPE-DATE:CAPS"></a><span class="term"><code class="literal">MRP_PROPERTY_TYPE_DATE</code></span></p></td>
<td>date type
</td>
</tr>
<tr>
<td><p><a name="MRP-PROPERTY-TYPE-DURATION:CAPS"></a><span class="term"><code class="literal">MRP_PROPERTY_TYPE_DURATION</code></span></p></td>
<td>duration type
</td>
</tr>
<tr>
<td><p><a name="MRP-PROPERTY-TYPE-COST:CAPS"></a><span class="term"><code class="literal">MRP_PROPERTY_TYPE_COST</code></span></p></td>
<td>cost type (float)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-new"></a><h3>mrp_property_new ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="returnvalue">MrpProperty</span></a> *       mrp_property_new                    (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType"><span class="type">MrpPropertyType</span></a> type</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> user_defined</code></em>);</pre>
<p>
Creates a new <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>. <em class="parameter"><code>name</code></em> must be unique in the application.
<em class="parameter"><code>user_defined</code></em> specifies if the property was created by a user or a plugin
or Planner itself.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the property</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType"><span class="type">MrpPropertyType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>the human readable label</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td>a string describing the property</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_defined</code></em> :</span></p></td>
<td>a <span class="type">gboolean</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly create property</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-get-name"></a><h3>mrp_property_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       mrp_property_get_name               (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);</pre>
<p>
Fetches the name of <em class="parameter"><code>property</code></em>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the name of <em class="parameter"><code>property</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-get-property-type"></a><h3>mrp_property_get_property_type ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType"><span class="returnvalue">MrpPropertyType</span></a>     mrp_property_get_property_type      (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);</pre>
<p>
Fetches the type of <em class="parameter"><code>property</code></em>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the type of <em class="parameter"><code>property</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-set-label"></a><h3>mrp_property_set_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                mrp_property_set_label              (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre>
<p>
Sets the label of <em class="parameter"><code>property</code></em> and signals the "property-changed" signal on
the project <em class="parameter"><code>property</code></em> is attached to.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>a string containing the new label</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-get-label"></a><h3>mrp_property_get_label ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       mrp_property_get_label              (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);</pre>
<p>
Fetches the label of <em class="parameter"><code>property</code></em>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the label of <em class="parameter"><code>property</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-set-description"></a><h3>mrp_property_set_description ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                mrp_property_set_description        (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>);</pre>
<p>
Sets the description of <em class="parameter"><code>property</code></em> and signals the "property-changed" signal on the project <em class="parameter"><code>property</code></em> is attached to.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td>a string containing the new description</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-get-description"></a><h3>mrp_property_get_description ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       mrp_property_get_description        (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);</pre>
<p>
Fetches the description of <em class="parameter"><code>property</code></em>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the description of <em class="parameter"><code>property</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-set-user-defined"></a><h3>mrp_property_set_user_defined ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                mrp_property_set_user_defined       (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> user_defined</code></em>);</pre>
<p>
Sets if <em class="parameter"><code>property</code></em> is user-defined or created by a plugin or Planner
itself.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_defined</code></em> :</span></p></td>
<td>if the property is user defined</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-get-user-defined"></a><h3>mrp_property_get_user_defined ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            mrp_property_get_user_defined       (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);</pre>
<p>
Fetches if <em class="parameter"><code>property</code></em> is uesr defined or not.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>property</code></em> is user defined, otherwise <code class="literal">FALSE</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-ref"></a><h3>mrp_property_ref ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="returnvalue">MrpProperty</span></a> *       mrp_property_ref                    (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);</pre>
<p>
Add a reference to <em class="parameter"><code>property</code></em>. User should call this when storing a reference
to <em class="parameter"><code>property</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the property</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-unref"></a><h3>mrp_property_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                mrp_property_unref                  (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a> *property</code></em>);</pre>
<p>
Remove a reference from <em class="parameter"><code>property</code></em>. If the reference count reaches 0 the
property will be freed. User should not use it's reference after calling
<a class="link" href="libplanner-mrp-property.html#mrp-property-unref" title="mrp_property_unref ()"><code class="function">mrp_property_unref()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpProperty" title="MrpProperty"><span class="type">MrpProperty</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-property-type-as-string"></a><h3>mrp_property_type_as_string ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       mrp_property_type_as_string         (<em class="parameter"><code><a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType"><span class="type">MrpPropertyType</span></a> type</code></em>);</pre>
<p>
Transform a <span class="type">MrpPropertyTYpe</span> into a human readable string.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-property.html#MrpPropertyType" title="enum MrpPropertyType"><span class="type">MrpPropertyType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a string representation of <em class="parameter"><code>type</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.