intl/icu/source/i18n/unicode/ugender.h@6474c204b198
intl/icu/source/i18n/unicode/ugender.h
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
1 /*
2 *****************************************************************************************
3 * Copyright (C) 2010-2013, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 *****************************************************************************************
6 */
8 #ifndef UGENDER_H
9 #define UGENDER_H
11 #include "unicode/utypes.h"
13 #if !UCONFIG_NO_FORMATTING
15 #include "unicode/localpointer.h"
17 /**
18 * \file
19 * \brief C API: The purpose of this API is to compute the gender of a list as a
20 * whole given the gender of each element.
21 *
22 */
24 /**
25 * Genders
26 * @stable ICU 50
27 */
28 enum UGender {
29 /**
30 * Male gender.
31 * @stable ICU 50
32 */
33 UGENDER_MALE,
34 /**
35 * Female gender.
36 * @stable ICU 50
37 */
38 UGENDER_FEMALE,
39 /**
40 * Neutral gender.
41 * @stable ICU 50
42 */
43 UGENDER_OTHER
44 };
45 /**
46 * @stable ICU 50
47 */
48 typedef enum UGender UGender;
50 /**
51 * Opaque UGenderInfo object for use in C programs.
52 * @stable ICU 50
53 */
54 struct UGenderInfo;
55 typedef struct UGenderInfo UGenderInfo;
57 /**
58 * Opens a new UGenderInfo object given locale.
59 * @param locale The locale for which the rules are desired.
60 * @param status UErrorCode pointer
61 * @return A UGenderInfo for the specified locale, or NULL if an error occurred.
62 * @stable ICU 50
63 */
64 U_STABLE const UGenderInfo* U_EXPORT2
65 ugender_getInstance(const char *locale, UErrorCode *status);
68 /**
69 * Given a list, returns the gender of the list as a whole.
70 * @param genderInfo pointer that ugender_getInstance returns.
71 * @param genders the gender of each element in the list.
72 * @param size the size of the list.
73 * @param status A pointer to a UErrorCode to receive any errors.
74 * @return The gender of the list.
75 * @stable ICU 50
76 */
77 U_STABLE UGender U_EXPORT2
78 ugender_getListGender(const UGenderInfo* genderinfo, const UGender *genders, int32_t size, UErrorCode *status);
80 #endif /* #if !UCONFIG_NO_FORMATTING */
82 #endif
