summaryrefslogtreecommitdiff
path: root/src/libical-glib/api/i-cal-restriction.xml
blob: 5bc4fe4005c470c75c76d468c20d3b7040cc26d4 (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
<!--
  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="Restriction">
    <enum name="ICalRestrictionKind" native_name="icalrestriction_kind" default_native="I_CAL_RESTRICTION_UNKNOWN">
        <element name="ICAL_RESTRICTION_NONE"/>
        <element name="ICAL_RESTRICTION_ZERO"/>
        <element name="ICAL_RESTRICTION_ONE"/>
        <element name="ICAL_RESTRICTION_ZEROPLUS"/>
        <element name="ICAL_RESTRICTION_ONEPLUS"/>
        <element name="ICAL_RESTRICTION_ZEROORONE"/>
        <element name="ICAL_RESTRICTION_ONEEXCLUSIVE"/>
        <element name="ICAL_RESTRICTION_ONEMUTUAL"/>
        <element name="ICAL_RESTRICTION_UNKNOWN"/>
    </enum>
    <method name="i_cal_restriction_compare" corresponds="icalrestriction_compare" kind="" since="1.0">
        <parameter type="ICalRestrictionKind" name="restr" comment="The restriction kind"/>
        <parameter type="gint" name="count" comment="The number of restrictions"/>
        <returns type="gint" comment="Whether it is valid or not. -1 indicates invalid or more analysis. 1 indicates pass and 0 or 2+ indicates fail."/>
        <comment xml:space="preserve">Compares the kind of restriction and the count to determine whether it is valid.</comment>
    </method>
    <method name="i_cal_restriction_check" corresponds="icalrestriction_check" since="1.0">
        <parameter type="ICalComponent *" name="comp" comment="The component to be checked"/>
        <returns type="gint" comment="Whether the @comp is valid."/>
        <comment xml:space="preserve">Checks whether the #ICalComponent is valid.</comment>
    </method>
</structure>