summaryrefslogtreecommitdiff
path: root/src/libical-glib/api/i-cal-period.xml
blob: 1b02bbc689d1ad86fc4a917c857c3d30f27dee8b (plain)
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
<!--
  Copyright (C) 2015 William Yu <williamyu@gnome.org>

  This library is free software: you can redistribute it and/or modify it
  under the terms of version 2.1. of the GNU Lesser General Public License
  as published by the Free Software Foundation.

  This library is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with this library. If not, see <https://www.gnu.org/licenses/>.
-->
<structure namespace="ICal" name="Period" native="struct icalperiodtype" is_bare="true" default_native="icalperiodtype_null_period ()">
	<method name="i_cal_period_get_start" corresponds="CUSTOM" kind="get" since="1.0">
		<parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried"/>
		<returns type="ICalTime *" annotation="transfer full" comment="The start of @period."/>
		<comment>Gets the start time from an #ICalPeriod.</comment>
		<custom>	g_return_val_if_fail (period != NULL, NULL);
	g_return_val_if_fail (I_CAL_IS_PERIOD (period), NULL);

	return i_cal_time_new_full ((* (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period)).start);</custom>
	</method>
	<method name="i_cal_period_set_start" corresponds="CUSTOM" kind="set" since="1.0">
		<parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set"/>
		<parameter type="ICalTime *" name="start" comment="The start of @period"/>
		<comment>Sets the start time of an #ICalPeriod.</comment>
		<custom>	struct icalperiodtype *periodtype;
	g_return_if_fail (period != NULL);
	g_return_if_fail (I_CAL_IS_PERIOD (period));
	g_return_if_fail (start != NULL);
	g_return_if_fail (I_CAL_IS_TIME(start));

	periodtype = (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period);
	periodtype->start = * (struct icaltimetype *)i_cal_object_get_native ((ICalObject *)start);</custom>
	</method>
	<method name="i_cal_period_get_end" corresponds="CUSTOM" kind="get" since="1.0">
		<parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried"/>
		<returns type="ICalTime *" annotation="transfer full" comment="The end of @period."/>
		<comment>Gets the end time from an #ICalPeriod.</comment>
		<custom>	g_return_val_if_fail (period != NULL, NULL);
	g_return_val_if_fail (I_CAL_IS_PERIOD (period), NULL);

	return i_cal_time_new_full ((* (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period)).end);</custom>
	</method>
	<method name="i_cal_period_set_end" corresponds="CUSTOM" kind="set" since="1.0">
		<parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set"/>
		<parameter type="ICalTime *" name="end" comment="The end of @period"/>
		<comment>Sets the end time of an #ICalPeriod.</comment>
		<custom>	struct icalperiodtype *periodtype;
	g_return_if_fail (period != NULL);
	g_return_if_fail (I_CAL_IS_PERIOD (period));
	g_return_if_fail (end != NULL);
	g_return_if_fail (I_CAL_IS_TIME(end));

	periodtype = (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period);
	periodtype->end = (* (struct icaltimetype *)i_cal_object_get_native ((ICalObject *)end));</custom>
	</method>
	<method name="i_cal_period_get_duration" corresponds="CUSTOM" kind="get" since="1.0">
		<parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be queried"/>
		<returns type="ICalDuration *" annotation="transfer full" comment="The duration of @period."/>
		<comment>Gets the duration from an #ICalPeriod.</comment>
		<custom>	g_return_val_if_fail (period != NULL, NULL);
	g_return_val_if_fail (I_CAL_IS_PERIOD (period), NULL);

	return i_cal_duration_new_full ((* (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period)).duration);</custom>
	</method>
	<method name="i_cal_period_set_duration" corresponds="CUSTOM" kind="set" since="1.0">
		<parameter type="ICalPeriod *" name="period" comment="The #ICalPeriod to be set"/>
		<parameter type="ICalDuration *" name="duration" comment="The duration of @period"/>
		<comment>Sets the duration of an #ICalPeriod.</comment>
		<custom>	struct icalperiodtype *periodtype;
	g_return_if_fail (period != NULL);
	g_return_if_fail (I_CAL_IS_PERIOD (period));
	g_return_if_fail (duration != NULL);
	g_return_if_fail (I_CAL_IS_DURATION(duration));

	periodtype = (struct icalperiodtype *)i_cal_object_get_native ((ICalObject *)period);
	periodtype->duration = (* (struct icaldurationtype *)i_cal_object_get_native ((ICalObject *)duration));</custom>
	</method>
    <method name="i_cal_period_new_from_string" corresponds="icalperiodtype_from_string" kind="constructor" since="1.0">
        <parameter type="const gchar *" name="str" comment="The string used to create the #ICalPeriod"/>
        <returns type="ICalPeriod *" annotation="transfer full" comment="The newly created #ICalPeriod"/>
        <comment xml:space="preserve">Creates a #ICalPeriod from a string.</comment>
    </method>
    <method name="i_cal_period_as_ical_string" corresponds="icalperiodtype_as_ical_string_r" since="1.0">
        <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be translated"/>
        <returns type="gchar *" annotation="transfer full" comment="The string representation of #ICalPeriod."/>
        <comment xml:space="preserve">Translates #ICalPeriod to string.</comment>
    </method>
    <method name="i_cal_period_new_null_period" corresponds="icalperiodtype_null_period" kind="constructor" since="1.0">
        <returns type="ICalPeriod *" annotation="transfer full" comment="The newly created default #ICalPeriod"/>
        <comment xml:space="preserve">Creates a default #ICalPeriod.</comment>
    </method>
    <method name="i_cal_period_is_null_period" corresponds="icalperiodtype_is_null_period" since="1.0">
        <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be checked"/>
        <returns type="gboolean" comment="1 if yes, 0 if not."/>
        <comment xml:space="preserve">Checks the #ICalPeriod is null_period.</comment>
    </method>
    <method name="i_cal_period_is_valid_period" corresponds="icalperiodtype_is_valid_period" since="1.0">
        <parameter type="ICalPeriod *" name="p" comment="The #ICalPeriod to be checked"/>
        <returns type="gboolean" comment="1 if yes, 0 if not."/>
        <comment xml:space="preserve">Checks the #ICalPeriod is valid_period.</comment>
    </method>
</structure>