SDL
3.0
SDL_locale.h
Go to the documentation of this file.
1
/*
2
Simple DirectMedia Layer
3
Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
4
5
This software is provided 'as-is', without any express or implied
6
warranty. In no event will the authors be held liable for any damages
7
arising from the use of this software.
8
9
Permission is granted to anyone to use this software for any purpose,
10
including commercial applications, and to alter it and redistribute it
11
freely, subject to the following restrictions:
12
13
1. The origin of this software must not be misrepresented; you must not
14
claim that you wrote the original software. If you use this software
15
in a product, an acknowledgment in the product documentation would be
16
appreciated but is not required.
17
2. Altered source versions must be plainly marked as such, and must not be
18
misrepresented as being the original software.
19
3. This notice may not be removed or altered from any source distribution.
20
*/
21
22
/**
23
* # CategoryLocale
24
*
25
* SDL locale services.
26
*/
27
28
#ifndef SDL_locale_h
29
#define SDL_locale_h
30
31
#include <
SDL3/SDL_stdinc.h
>
32
#include <
SDL3/SDL_error.h
>
33
34
#include <
SDL3/SDL_begin_code.h
>
35
/* Set up for C function definitions, even when using C++ */
36
#ifdef __cplusplus
37
/* *INDENT-OFF* */
38
extern
"C"
{
39
/* *INDENT-ON* */
40
#endif
41
42
/**
43
* A struct to provide locale data.
44
*
45
* Locale data is split into a spoken language, like English, and an optional
46
* country, like Canada. The language will be in ISO-639 format (so English
47
* would be "en"), and the country, if not NULL, will be an ISO-3166 country
48
* code (so Canada would be "CA").
49
*
50
* \since This function is available since SDL 3.0.0.
51
*
52
* \sa SDL_GetPreferredLocales
53
*/
54
typedef
struct
SDL_Locale
55
{
56
const
char
*
language
;
/**< A language name, like "en" for English. */
57
const
char
*
country
;
/**< A country, like "US" for America. Can be NULL. */
58
}
SDL_Locale
;
59
60
/**
61
* Report the user's preferred locale.
62
*
63
* Returned language strings are in the format xx, where 'xx' is an ISO-639
64
* language specifier (such as "en" for English, "de" for German, etc).
65
* Country strings are in the format YY, where "YY" is an ISO-3166 country
66
* code (such as "US" for the United States, "CA" for Canada, etc). Country
67
* might be NULL if there's no specific guidance on them (so you might get {
68
* "en", "US" } for American English, but { "en", NULL } means "English
69
* language, generically"). Language strings are never NULL, except to
70
* terminate the array.
71
*
72
* Please note that not all of these strings are 2 characters; some are three
73
* or more.
74
*
75
* The returned list of locales are in the order of the user's preference. For
76
* example, a German citizen that is fluent in US English and knows enough
77
* Japanese to navigate around Tokyo might have a list like: { "de", "en_US",
78
* "jp", NULL }. Someone from England might prefer British English (where
79
* "color" is spelled "colour", etc), but will settle for anything like it: {
80
* "en_GB", "en", NULL }.
81
*
82
* This function returns NULL on error, including when the platform does not
83
* supply this information at all.
84
*
85
* This might be a "slow" call that has to query the operating system. It's
86
* best to ask for this once and save the results. However, this list can
87
* change, usually because the user has changed a system preference outside of
88
* your program; SDL will send an SDL_EVENT_LOCALE_CHANGED event in this case,
89
* if possible, and you can call this function again to get an updated copy of
90
* preferred locales.
91
*
92
* \param count a pointer filled in with the number of locales returned, may
93
* be NULL.
94
* \returns a NULL terminated array of locale pointers, or NULL on failure;
95
* call SDL_GetError() for more information. This is a single
96
* allocation that should be freed with SDL_free() when it is no
97
* longer needed.
98
*
99
* \since This function is available since SDL 3.0.0.
100
*/
101
extern
SDL_DECLSPEC
SDL_Locale
** SDLCALL
SDL_GetPreferredLocales
(
int
*count);
102
103
/* Ends C function definitions when using C++ */
104
#ifdef __cplusplus
105
/* *INDENT-OFF* */
106
}
107
/* *INDENT-ON* */
108
#endif
109
#include <
SDL3/SDL_close_code.h
>
110
111
#endif
/* SDL_locale_h */
SDL_begin_code.h
SDL_close_code.h
SDL_error.h
SDL_GetPreferredLocales
SDL_Locale ** SDL_GetPreferredLocales(int *count)
SDL_stdinc.h
SDL_Locale
Definition
SDL_locale.h:55
SDL_Locale::country
const char * country
Definition
SDL_locale.h:57
SDL_Locale::language
const char * language
Definition
SDL_locale.h:56
include
SDL3
SDL_locale.h
Generated by
1.9.8