summaryrefslogtreecommitdiff
path: root/src/libical-glib/api/i-cal-parameter.xml
blob: a3a6f9195a03b53f12e0343ecead4b4eb2af444a (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
108
109
110
<!--
  SPDX-FileCopyrightText: 2015 William Yu <williamyu@gnome.org>

  SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0


-->
<structure namespace="ICal" name="Parameter" native="icalparameter" destroy_func="icalparameter_free">
    <method name="i_cal_parameter_new" corresponds="icalparameter_new" kind="constructor" since="1.0">
        <parameter type="ICalParameterKind" name="v" comment="The type of #ICalParameter to be created"/>
        <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter." />
        <comment xml:space="preserve">Creates a new #ICalParameter according to the kind type.</comment>
    </method>
    <method name="i_cal_parameter_clone" corresponds="icalparameter_clone" kind="clone" since="3.1">
        <parameter type="const ICalParameter *" name="p" annotation="in" comment="The #ICalParameter to be cloned"/>
        <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter with the same properties as the @p." />
        <comment xml:space="preserve">Deep clone a #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_new_from_string" corresponds="icalparameter_new_from_string" kind="constructor" since="1.0">
        <parameter type="const gchar *" name="value" annotation="in, transfer none" comment="The string from which the #ICalParameter is created"/>
        <returns type="ICalParameter *" annotation="transfer full" comment="The newly created $ICalParameter with the properties specified in the @value." />
        <comment xml:space="preserve">Creates a #ICalParameter from a string of form "PARAMNAME=VALUE".</comment>
    </method>
    <method name="i_cal_parameter_new_from_value_string" corresponds="icalparameter_new_from_value_string" kind="constructor" since="1.0">
        <parameter type="ICalParameterKind" name="kind" comment="The kind of #ICalParameter to be created"/>
        <parameter type="const gchar *" name="value" comment="The string from which #ICalParameter to be created"/>
        <returns type="ICalParameter *" annotation="transfer full" comment="The newly created #ICalParameter" />
        <comment xml:space="preserve">Creates a new #ICalParameter from just the value, the part after the "="</comment>
    </method>
    <method name="i_cal_parameter_free" corresponds="icalparameter_free" annotation="skip" kind="destructor" since="1.0">
        <parameter type="ICalParameter *" name="parameter" annotation="in" comment="The #ICalParameter to be freed"/>
        <comment xml:space="preserve">Frees the native part of the ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_as_ical_string" corresponds="icalparameter_as_ical_string_r" kind="others" since="1.0">
        <parameter type="ICalParameter *" name="parameter" annotation="in" comment="The #ICalParameter to be converted"/>
        <returns type="gchar *" annotation="transfer full" comment="The string representation of the @parameter." />
        <comment xml:space="preserve">Converts an #ICalParameter to the string representation.</comment>
    </method>
    <method name="i_cal_parameter_isa" corresponds="icalparameter_isa" kind="others" since="1.0">
        <parameter type="ICalParameter *" name="parameter" comment="The #ICalParameter to be determined for the type"/>
        <returns type="ICalParameterKind" comment="The type of the @parameter." />
        <comment xml:space="preserve">Checks the type of a #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_isa_parameter" corresponds="icalparameter_isa_parameter" kind="others" since="1.0">
        <parameter type="ICalParameter *" name="param" annotation="in" comment="The #ICalParameter to be checked"/>
        <returns type="gint" comment="1 if the native part is of type icalparameter, 0 if not." />
        <comment xml:space="preserve">Checks whether the native part of the #ICalParameter is of type icalparameter.</comment>
    </method>
    <method name="i_cal_parameter_set_xname" corresponds="icalparameter_set_xname" kind="set" since="1.0">
        <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the xname to be set"/>
        <parameter type="const gchar *" name="v" comment="The name to be set into the @param"/>
        <comment xml:space="preserve">Sets the xname property of the native part of the #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_get_xname" corresponds="icalparameter_get_xname" kind="get" since="1.0">
        <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be queried"/>
        <returns type="const gchar *" annotation="nullable" comment="The property of the @value" />
        <comment xml:space="preserve">Gets the xname property of the native part of the #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_set_xvalue" corresponds="icalparameter_set_xvalue" kind="set" since="1.0">
        <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the xvalue to be set"/>
        <parameter type="const gchar *" name="v" comment="The value to be set into the @param"/>
        <comment xml:space="preserve">Sets the xvalue property of the native part of the #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_get_xvalue" corresponds="icalparameter_get_xvalue" kind="get" since="1.0">
        <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be queried"/>
        <returns type="const gchar *" annotation="nullable" comment="The property of the @value" />
        <comment xml:space="preserve">Gets the xvalue property of the native part of the #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_set_iana_name" corresponds="icalparameter_set_iana_name" kind="set" since="1.0">
        <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the iana_name to be set"/>
        <parameter type="const gchar *" name="v" comment="The name to be set into the @param"/>
        <comment xml:space="preserve">Sets the iana_name property of the native part of the #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_get_iana_name" corresponds="icalparameter_get_iana_name" kind="get" since="1.0">
        <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be queried"/>
        <returns type="const gchar *" annotation="nullable" comment="The property of the @value" />
        <comment xml:space="preserve">Gets the iana_name property of the native part of the #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_set_iana_value" corresponds="icalparameter_set_iana_value" kind="set" since="1.0">
        <parameter type="ICalParameter *" name="param" comment="The #ICalParameter of which the iana_value to be set"/>
        <parameter type="const gchar *" name="v" comment="The value to be set into the @param"/>
        <comment xml:space="preserve">Sets the iana_value property of the native part of the #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_get_iana_value" corresponds="icalparameter_get_iana_value" kind="get" since="1.0">
        <parameter type="ICalParameter *" name="param" comment="The #ICalParameter to be queried"/>
        <returns type="const gchar *" annotation="nullable" comment="The property of the @value" />
        <comment xml:space="preserve">Gets the iana_value property of the native part of the #ICalParameter.</comment>
    </method>
    <method name="i_cal_parameter_has_same_name" corresponds="icalparameter_has_same_name" kind="others" since="1.0">
        <parameter type="ICalParameter *" name="param1" comment="The #ICalParameter to be checked"/>
        <parameter type="ICalParameter *" name="param2" comment="The #ICalParameter to be checked"/>
        <returns type="gint" comment="1 if the parameters have the same name, 0 or not." />
        <comment xml:space="preserve">Checks whether native parts of two #ICalParameters have the same name.</comment>
    </method>
    <method name="i_cal_parameter_kind_to_string" corresponds="icalparameter_kind_to_string" kind="others" since="1.0">
        <parameter type="ICalParameterKind" name="kind" comment="The #ICalParameterKind to be converted"/>
        <returns type="const gchar *" comment="The string representation of @kind." />
        <comment xml:space="preserve">Converts the #ICalParameter to the string representation.</comment>
    </method>
    <method name="i_cal_parameter_kind_from_string" corresponds="icalparameter_string_to_kind" kind="others" since="1.0">
        <parameter type="const gchar *" name="string" comment="The string representation of the #ICalParameter"/>
        <returns type="ICalParameterKind" comment="The #ICalParameterKind converted from @string" />
        <comment xml:space="preserve">Converts a string to the #ICalParameterKind.</comment>
    </method>
    <method name="i_cal_parameter_kind_is_valid" corresponds="icalparameter_kind_is_valid" since="3.0.5">
        <parameter type="const ICalParameterKind" name="kind" comment="The #ICalPropertyKind"/>
        <returns type="gboolean" comment="1 if valid, 0 if not."/>
        <comment xml:space="preserve">Checks whether #ICalParameterKind is valid.</comment>
    </method>
</structure>