aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/icu/include/unicode/gender.h
blob: 0fa50eccac03b32b35aea763cdf34b12328ec5be (plain) (blame)
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
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html 
/* 
******************************************************************************* 
* Copyright (C) 2008-2013, International Business Machines Corporation and 
* others. All Rights Reserved. 
******************************************************************************* 
* 
* 
* File GENDER.H 
* 
* Modification History:* 
*   Date        Name        Description 
* 
******************************************************************************** 
*/ 
 
#ifndef _GENDER 
#define _GENDER 
 
/**
 * \file
 * \brief C++ API: GenderInfo computes the gender of a list.
 */

#include "unicode/utypes.h" 
 
#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_FORMATTING 
 
#include "unicode/locid.h" 
#include "unicode/ugender.h" 
#include "unicode/uobject.h" 
 
class GenderInfoTest; 
 
U_NAMESPACE_BEGIN 
 
/** \internal Forward Declaration  */
void U_CALLCONV GenderInfo_initCache(UErrorCode &status); 
 
/** 
 * GenderInfo computes the gender of a list as a whole given the gender of 
 * each element. 
 * @stable ICU 50 
 */ 
class U_I18N_API GenderInfo : public UObject { 
public: 
 
    /** 
     * Provides access to the predefined GenderInfo object for a given 
     * locale. 
     * 
     * @param locale  The locale for which a <code>GenderInfo</code> object is 
     *                returned. 
     * @param status  Output param set to success/failure code on exit, which 
     *                must not indicate a failure before the function call. 
     * @return        The predefined <code>GenderInfo</code> object pointer for 
     *                this locale. The returned object is immutable, so it is 
     *                declared as const. Caller does not own the returned 
     *                pointer, so it must not attempt to free it. 
     * @stable ICU 50 
     */ 
    static const GenderInfo* U_EXPORT2 getInstance(const Locale& locale, UErrorCode& status); 
 
    /** 
     * Determines the gender of a list as a whole given the gender of each 
     * of the elements. 
     *  
     * @param genders the gender of each element in the list. 
     * @param length the length of gender array. 
     * @param status  Output param set to success/failure code on exit, which 
     *                must not indicate a failure before the function call. 
     * @return        the gender of the whole list. 
     * @stable ICU 50 
     */ 
    UGender getListGender(const UGender* genders, int32_t length, UErrorCode& status) const; 
 
    /** 
     * Destructor. 
     * 
     * @stable ICU 50 
     */ 
    virtual ~GenderInfo(); 
 
private: 
    int32_t _style; 
 
    /** 
     * Copy constructor. One object per locale invariant. Clients 
     * must never copy GenderInfo objects. 
     */ 
    GenderInfo(const GenderInfo& other); 
 
    /** 
      * Assignment operator. Not applicable to immutable objects. 
      */ 
    GenderInfo& operator=(const GenderInfo&); 
 
    GenderInfo(); 
 
    static const GenderInfo* getNeutralInstance(); 
 
    static const GenderInfo* getMixedNeutralInstance(); 
 
    static const GenderInfo* getMaleTaintsInstance(); 
 
    static const GenderInfo* loadInstance(const Locale& locale, UErrorCode& status); 
 
    friend class ::GenderInfoTest; 
    friend void U_CALLCONV GenderInfo_initCache(UErrorCode &status); 
}; 
 
U_NAMESPACE_END 
 
#endif /* #if !UCONFIG_NO_FORMATTING */ 
 
#endif /* U_SHOW_CPLUSPLUS_API */

#endif // _GENDER 
//eof