/usr/share/gtk-doc/html/libplanner/libplanner-mrp-calendar.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 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MrpCalendar</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-assignment.html" title="MrpAssignment">
<link rel="next" href="libplanner-mrp-group.html" title="MrpGroup">
<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-assignment.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-group.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-calendar.synopsis" class="shortcut">Top</a>
|
<a href="#libplanner-mrp-calendar.description" class="shortcut">Description</a>
|
<a href="#libplanner-mrp-calendar.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libplanner-mrp-calendar.properties" class="shortcut">Properties</a>
|
<a href="#libplanner-mrp-calendar.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="libplanner-mrp-calendar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libplanner-mrp-calendar.top_of_page"></a>MrpCalendar</span></h2>
<p>MrpCalendar — represents a calendar in the project.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libplanner-mrp-calendar.synopsis"></a><h2>Synopsis</h2>
<a name="MrpCalendar"></a><pre class="synopsis">
#include <libplanner/planner.h>
<a class="link" href="libplanner-mrp-calendar.html#MrpCalendarPriv" title="MrpCalendarPriv">MrpCalendarPriv</a>;
struct <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar-struct" title="struct MrpCalendar">MrpCalendar</a>;
<a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval">MrpInterval</a>;
<a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="returnvalue">MrpCalendar</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-new" title="mrp_calendar_new ()">mrp_calendar_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-project.html#MrpProject"><span class="type">MrpProject</span></a> *project</code></em>);
<a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="returnvalue">MrpCalendar</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-copy" title="mrp_calendar_copy ()">mrp_calendar_copy</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);
<a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="returnvalue">MrpCalendar</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-derive" title="mrp_calendar_derive ()">mrp_calendar_derive</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *parent</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-reparent" title="mrp_calendar_reparent ()">mrp_calendar_reparent</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *new_parent</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *child</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-remove" title="mrp_calendar_remove ()">mrp_calendar_remove</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-get-name" title="mrp_calendar_get_name ()">mrp_calendar_get_name</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-set-name" title="mrp_calendar_set_name ()">mrp_calendar_set_name</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-day-set-intervals" title="mrp_calendar_day_set_intervals ()">mrp_calendar_day_set_intervals</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> *day</code></em>,
<em class="parameter"><code><span class="type">GList</span> *intervals</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-day-get-intervals" title="mrp_calendar_day_get_intervals ()">mrp_calendar_day_get_intervals</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> *day</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> check_ancestors</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-day-get-total-work" title="mrp_calendar_day_get_total_work ()">mrp_calendar_day_get_total_work</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> *day</code></em>);
<a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="returnvalue">MrpDay</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-get-day" title="mrp_calendar_get_day ()">mrp_calendar_get_day</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> date</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> check_ancestors</code></em>);
<a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="returnvalue">MrpDay</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-get-default-day" title="mrp_calendar_get_default_day ()">mrp_calendar_get_default_day</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><span class="type">gint</span> week_day</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-set-default-days" title="mrp_calendar_set_default_days ()">mrp_calendar_set_default_days</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><span class="type">gint</span> week_day</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-set-days" title="mrp_calendar_set_days ()">mrp_calendar_set_days</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> date</code></em>,
<em class="parameter"><code>...</code></em>);
<a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="returnvalue">MrpCalendar</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-get-parent" title="mrp_calendar_get_parent ()">mrp_calendar_get_parent</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-get-children" title="mrp_calendar_get_children ()">mrp_calendar_get_children</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);
<a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="returnvalue">MrpInterval</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-interval-new" title="mrp_interval_new ()">mrp_interval_new</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> start</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> end</code></em>);
<a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="returnvalue">MrpInterval</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-interval-copy" title="mrp_interval_copy ()">mrp_interval_copy</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> *interval</code></em>);
<a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="returnvalue">MrpInterval</span></a> * <a class="link" href="libplanner-mrp-calendar.html#mrp-interval-ref" title="mrp_interval_ref ()">mrp_interval_ref</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> *interval</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-interval-unref" title="mrp_interval_unref ()">mrp_interval_unref</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> *interval</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libplanner-mrp-calendar.html#mrp-interval-get-absolute" title="mrp_interval_get_absolute ()">mrp_interval_get_absolute</a> (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> *interval</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> offset</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> *start</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> *end</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libplanner-mrp-calendar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="libplanner-mrp-object.html#MrpObject">MrpObject</a>
+----MrpCalendar
</pre>
</div>
<div class="refsect1">
<a name="libplanner-mrp-calendar.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="libplanner-mrp-calendar.html#MrpCalendar--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write
"<a class="link" href="libplanner-mrp-calendar.html#MrpCalendar--project" title='The "project" property'>project</a>" <span class="type">gpointer</span> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="libplanner-mrp-calendar.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="libplanner-mrp-calendar.html#MrpCalendar-calendar-changed" title='The "calendar-changed" signal'>calendar-changed</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="libplanner-mrp-calendar.description"></a><h2>Description</h2>
<p>
A calendar contains the information on working/nonworking time for
resources. A calendar has a default week, specifying the day types
(<a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a>) used for each day of the week by default.
</p>
<p>
Day types can be overriden so that a working day
has another set of working time intervals per calendar. Certain dates
can be overridden to use another day type as well.
</p>
</div>
<div class="refsect1">
<a name="libplanner-mrp-calendar.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MrpCalendarPriv"></a><h3>MrpCalendarPriv</h3>
<pre class="programlisting">typedef struct _MrpCalendarPriv MrpCalendarPriv;</pre>
<p>
A private struct for internal use only. The definition of this
structure is not publically available.
</p>
</div>
<hr>
<div class="refsect2">
<a name="MrpCalendar-struct"></a><h3>struct MrpCalendar</h3>
<pre class="programlisting">struct MrpCalendar;</pre>
<p>
Object representing a calendar in the project.
</p>
</div>
<hr>
<div class="refsect2">
<a name="MrpInterval"></a><h3>MrpInterval</h3>
<pre class="programlisting">typedef struct _MrpInterval MrpInterval;</pre>
<p>
Represents a time interval.
</p>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-new"></a><h3>mrp_calendar_new ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="returnvalue">MrpCalendar</span></a> * mrp_calendar_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-project.html#MrpProject"><span class="type">MrpProject</span></a> *project</code></em>);</pre>
<p>
Creates a new <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>. The calendar will be empty so you need to set the
default week and/or override days, see <a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-set-default-days" title="mrp_calendar_set_default_days ()"><code class="function">mrp_calendar_set_default_days()</code></a> and
<a class="link" href="libplanner-mrp-calendar.html#mrp-calendar-set-days" title="mrp_calendar_set_days ()"><code class="function">mrp_calendar_set_days()</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>name</code></em> :</span></p></td>
<td>name of the calendar</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>project</code></em> :</span></p></td>
<td>the <a class="link" href="libplanner-mrp-project.html#MrpProject"><span class="type">MrpProject</span></a> that the new calendar will belong to</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-copy"></a><h3>mrp_calendar_copy ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="returnvalue">MrpCalendar</span></a> * mrp_calendar_copy (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);</pre>
<p>
Copies <em class="parameter"><code>calendar</code></em>, making the new calendar a base calendar, that does not have
a parent.
</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 new calendar</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>calendar</code></em> :</span></p></td>
<td>a <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> to copy</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> that is a copy of <em class="parameter"><code>calendar</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-derive"></a><h3>mrp_calendar_derive ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="returnvalue">MrpCalendar</span></a> * mrp_calendar_derive (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *parent</code></em>);</pre>
<p>
Derives a new calendar from <em class="parameter"><code>parent</code></em>. The new calendar will inherit all
properties from <em class="parameter"><code>parent</code></em>, so if no days are overridden, the calendars will be
identical.
</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 new calendar</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>the <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> to derive</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> that is derived from <em class="parameter"><code>parent</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-reparent"></a><h3>mrp_calendar_reparent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mrp_calendar_reparent (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *new_parent</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *child</code></em>);</pre>
<p>
Changes the parent of <em class="parameter"><code>calendar</code></em> so that it inherits <em class="parameter"><code>new_parent</code></em>, instead of
its old parent.
</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>new_parent</code></em> :</span></p></td>
<td>the new parent</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-remove"></a><h3>mrp_calendar_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mrp_calendar_remove (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);</pre>
<p>
Removes <em class="parameter"><code>calendar</code></em> from the project. If the calendar is used by the project, a
new calendar is set for the project. If the calendar has a parent, the parent
is used, otherwise the first child of the root is used. For resources, the
calendar is exchanged for the parent if one exists, otherwise the resource
calendar is unset, so that the project default will be used.
</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-get-name"></a><h3>mrp_calendar_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * mrp_calendar_get_name (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);</pre>
<p>
Retrieves the name of the calendar.
</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the calendar name.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-set-name"></a><h3>mrp_calendar_set_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mrp_calendar_set_name (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Sets the name of the calendar.
</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the new name</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-day-set-intervals"></a><h3>mrp_calendar_day_set_intervals ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mrp_calendar_day_set_intervals (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> *day</code></em>,
<em class="parameter"><code><span class="type">GList</span> *intervals</code></em>);</pre>
<p>
Overrides the working time for the day type <em class="parameter"><code>day</code></em> when used in <em class="parameter"><code>calendar</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>day</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>intervals</code></em> :</span></p></td>
<td>list of <a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> to set for the specified day</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-day-get-intervals"></a><h3>mrp_calendar_day_get_intervals ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * mrp_calendar_day_get_intervals (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> *day</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> check_ancestors</code></em>);</pre>
<p>
Retrieves the working time for the given day/calendar combination. If
<em class="parameter"><code>check_ancestors</code></em> is <code class="literal">TRUE</code>, the calendar hierarchy is searched until a
calendar that has set the working time for this day type is found. If <code class="literal">FALSE</code>,
the returned list will be empty if there is no explicit working time set for
<em class="parameter"><code>calendar</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>day</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_ancestors</code></em> :</span></p></td>
<td>specifies if the whole calendar hierarchy should be checked</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>List of <a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a>, specifying the working time for <em class="parameter"><code>day</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-day-get-total-work"></a><h3>mrp_calendar_day_get_total_work ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> mrp_calendar_day_get_total_work (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> *day</code></em>);</pre>
<p>
Calculates the total amount of work for <em class="parameter"><code>day</code></em> in <em class="parameter"><code>calendar</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>day</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the amount of work in seconds.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-get-day"></a><h3>mrp_calendar_get_day ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="returnvalue">MrpDay</span></a> * mrp_calendar_get_day (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> date</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> check_ancestors</code></em>);</pre>
<p>
Retrieves the day type for the given date and calender. If <em class="parameter"><code>check_ancestors</code></em>
is <code class="literal">TRUE</code>, the parent and grandparent, and so on, is searched if <em class="parameter"><code>calendar</code></em>
does not have an overridden day type for the specified date.
</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_ancestors</code></em> :</span></p></td>
<td>specifies if the whole calendar hierarchy should be checked</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-get-default-day"></a><h3>mrp_calendar_get_default_day ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="returnvalue">MrpDay</span></a> * mrp_calendar_get_default_day (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><span class="type">gint</span> week_day</code></em>);</pre>
<p>
Retrieves the default day for <em class="parameter"><code>calendar</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>week_day</code></em> :</span></p></td>
<td>integer in the range 0 - 6, where 0 is Sunday</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>default <a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-set-default-days"></a><h3>mrp_calendar_set_default_days ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mrp_calendar_set_default_days (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><span class="type">gint</span> week_day</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Sets days in the default week for <em class="parameter"><code>calendar</code></em>. Those are the days that are used
as fallback is a date is not overridden.
</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>week_day</code></em> :</span></p></td>
<td>integer in the range 0 - 6, where 0 is Sunday</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>
<a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> followed by more week day/<a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> pairs, terminated by -1</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-set-days"></a><h3>mrp_calendar_set_days ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mrp_calendar_set_days (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> date</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Overrides specific dates in <em class="parameter"><code>calendar</code></em>, setting the type of day to use for
those dates.
</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>
<a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> followed by more <a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a>/<a class="link" href="libplanner-mrp-day.html#MrpDay" title="MrpDay"><span class="type">MrpDay</span></a> pairs, terminated by -1</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-get-parent"></a><h3>mrp_calendar_get_parent ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="returnvalue">MrpCalendar</span></a> * mrp_calendar_get_parent (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);</pre>
<p>
Retrieves the parent calendar of <em class="parameter"><code>calendar</code></em>. The parent is the calendar that a
calendar falls back to if a date or day type is not overridden.
</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The parent calendar.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-calendar-get-children"></a><h3>mrp_calendar_get_children ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * mrp_calendar_get_children (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *calendar</code></em>);</pre>
<p>
Retreives a list of the children, i.e. the calenderas that are immediately
derived from <em class="parameter"><code>calendar</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>calendar</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>List of <em class="parameter"><code>calendar</code></em>'s children.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-interval-new"></a><h3>mrp_interval_new ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="returnvalue">MrpInterval</span></a> * mrp_interval_new (<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> start</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> end</code></em>);</pre>
<p>
Creates a new <a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> ranging from <em class="parameter"><code>start</code></em> to <em class="parameter"><code>end</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>start</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> specifying the start of the interval</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> specifying the end of the interval</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly created interval.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-interval-copy"></a><h3>mrp_interval_copy ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="returnvalue">MrpInterval</span></a> * mrp_interval_copy (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> *interval</code></em>);</pre>
<p>
Copies <em class="parameter"><code>interval</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>interval</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The copied interval.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-interval-ref"></a><h3>mrp_interval_ref ()</h3>
<pre class="programlisting"><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="returnvalue">MrpInterval</span></a> * mrp_interval_ref (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> *interval</code></em>);</pre>
<p>
Increases the reference count on <em class="parameter"><code>interval</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>interval</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The interval.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-interval-unref"></a><h3>mrp_interval_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mrp_interval_unref (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> *interval</code></em>);</pre>
<p>
Decreases the reference count on <em class="parameter"><code>interval</code></em>. When the count goes to 0, the
interval is freed.
</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>interval</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mrp-interval-get-absolute"></a><h3>mrp_interval_get_absolute ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mrp_interval_get_absolute (<em class="parameter"><code><a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a> *interval</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> offset</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> *start</code></em>,
<em class="parameter"><code><a class="link" href="libplanner-mrp-time.html#mrptime" title="mrptime"><span class="type">mrptime</span></a> *end</code></em>);</pre>
<p>
Retrieves the start and end time of <span class="type">interval</span>, with an optional <em class="parameter"><code>offset</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>interval</code></em> :</span></p></td>
<td>an <a class="link" href="libplanner-mrp-calendar.html#MrpInterval" title="MrpInterval"><span class="type">MrpInterval</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>the offset to add to start and end</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
<td>location to store start time, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
<td>location to store end time, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libplanner-mrp-calendar.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MrpCalendar--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write</pre>
<p>The name of the calendar.</p>
<p>Default value: "empty"</p>
</div>
<hr>
<div class="refsect2">
<a name="MrpCalendar--project"></a><h3>The <code class="literal">"project"</code> property</h3>
<pre class="programlisting"> "project" <span class="type">gpointer</span> : Read / Write</pre>
<p>The project this calendar belongs to.</p>
</div>
</div>
<div class="refsect1">
<a name="libplanner-mrp-calendar.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="MrpCalendar-calendar-changed"></a><h3>The <code class="literal">"calendar-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libplanner-mrp-calendar.html#MrpCalendar"><span class="type">MrpCalendar</span></a> *mrpcalendar,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
</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>mrpcalendar</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|