summaryrefslogtreecommitdiffstats
path: root/intl/icu_capi/cpp/docs/source/displaynames_ffi.rst
blob: 070f23b643185e0a6a788f016c3d2c206905bee1 (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
``displaynames::ffi``
=====================

.. cpp:enum-struct:: ICU4XDisplayNamesFallback

    See the `Rust documentation for Fallback <https://docs.rs/icu/latest/icu/displaynames/options/enum.Fallback.html>`__ for more information.


    .. cpp:enumerator:: Code

    .. cpp:enumerator:: None

.. cpp:struct:: ICU4XDisplayNamesOptionsV1

    See the `Rust documentation for DisplayNamesOptions <https://docs.rs/icu/latest/icu/displaynames/options/struct.DisplayNamesOptions.html>`__ for more information.


    .. cpp:member:: ICU4XDisplayNamesStyle style

        The optional formatting style to use for display name.


    .. cpp:member:: ICU4XDisplayNamesFallback fallback

        The fallback return when the system does not have the requested display name, defaults to "code".


    .. cpp:member:: ICU4XLanguageDisplay language_display

        The language display kind, defaults to "dialect".


.. cpp:enum-struct:: ICU4XDisplayNamesStyle

    See the `Rust documentation for Style <https://docs.rs/icu/latest/icu/displaynames/options/enum.Style.html>`__ for more information.


    .. cpp:enumerator:: Auto

    .. cpp:enumerator:: Narrow

    .. cpp:enumerator:: Short

    .. cpp:enumerator:: Long

    .. cpp:enumerator:: Menu

.. cpp:enum-struct:: ICU4XLanguageDisplay

    See the `Rust documentation for LanguageDisplay <https://docs.rs/icu/latest/icu/displaynames/options/enum.LanguageDisplay.html>`__ for more information.


    .. cpp:enumerator:: Dialect

    .. cpp:enumerator:: Standard

.. cpp:class:: ICU4XLocaleDisplayNamesFormatter

    See the `Rust documentation for LocaleDisplayNamesFormatter <https://docs.rs/icu/latest/icu/displaynames/struct.LocaleDisplayNamesFormatter.html>`__ for more information.


    .. cpp:function:: static diplomat::result<ICU4XLocaleDisplayNamesFormatter, ICU4XError> create(const ICU4XDataProvider& provider, const ICU4XLocale& locale, ICU4XDisplayNamesOptionsV1 options)

        Creates a new ``LocaleDisplayNamesFormatter`` from locale data and an options bag.

        See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/displaynames/struct.LocaleDisplayNamesFormatter.html#method.try_new>`__ for more information.


    .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> of_to_writeable(const ICU4XLocale& locale, W& write) const

        Returns the locale-specific display name of a locale.

        See the `Rust documentation for of <https://docs.rs/icu/latest/icu/displaynames/struct.LocaleDisplayNamesFormatter.html#method.of>`__ for more information.


    .. cpp:function:: diplomat::result<std::string, ICU4XError> of(const ICU4XLocale& locale) const

        Returns the locale-specific display name of a locale.

        See the `Rust documentation for of <https://docs.rs/icu/latest/icu/displaynames/struct.LocaleDisplayNamesFormatter.html#method.of>`__ for more information.


.. cpp:class:: ICU4XRegionDisplayNames

    See the `Rust documentation for RegionDisplayNames <https://docs.rs/icu/latest/icu/displaynames/struct.RegionDisplayNames.html>`__ for more information.


    .. cpp:function:: static diplomat::result<ICU4XRegionDisplayNames, ICU4XError> create(const ICU4XDataProvider& provider, const ICU4XLocale& locale)

        Creates a new ``RegionDisplayNames`` from locale data and an options bag.

        See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/displaynames/struct.RegionDisplayNames.html#method.try_new>`__ for more information.


    .. cpp:function:: template<typename W> diplomat::result<std::monostate, ICU4XError> of_to_writeable(const std::string_view region, W& write) const

        Returns the locale specific display name of a region. Note that the funtion returns an empty string in case the display name for a given region code is not found.

        See the `Rust documentation for of <https://docs.rs/icu/latest/icu/displaynames/struct.RegionDisplayNames.html#method.of>`__ for more information.


    .. cpp:function:: diplomat::result<std::string, ICU4XError> of(const std::string_view region) const

        Returns the locale specific display name of a region. Note that the funtion returns an empty string in case the display name for a given region code is not found.

        See the `Rust documentation for of <https://docs.rs/icu/latest/icu/displaynames/struct.RegionDisplayNames.html#method.of>`__ for more information.