Skip to main content

sdl3_sys/metadata/generated/
messagebox.rs

1//! Metadata for items in the `crate::messagebox` module
2
3use super::*;
4
5pub const METADATA_SDL_MessageBoxFlags: Group = Group {
6    module: "messagebox",
7    kind: GroupKind::Flags,
8    name: "SDL_MessageBoxFlags",
9    short_name: "MessageBoxFlags",
10    doc: Some(
11        "Message box flags.\n\nIf supported will display warning icon, etc.\n\n## Availability\nThis datatype is available since SDL 3.2.0.\n",
12    ),
13    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
14    values: &[
15        GroupValue {
16            name: "SDL_MESSAGEBOX_ERROR",
17            short_name: "ERROR",
18            doc: Some("error dialog\n"),
19            available_since: None,
20        },
21        GroupValue {
22            name: "SDL_MESSAGEBOX_WARNING",
23            short_name: "WARNING",
24            doc: Some("warning dialog\n"),
25            available_since: None,
26        },
27        GroupValue {
28            name: "SDL_MESSAGEBOX_INFORMATION",
29            short_name: "INFORMATION",
30            doc: Some("informational dialog\n"),
31            available_since: None,
32        },
33        GroupValue {
34            name: "SDL_MESSAGEBOX_BUTTONS_LEFT_TO_RIGHT",
35            short_name: "BUTTONS_LEFT_TO_RIGHT",
36            doc: Some("buttons placed left to right\n"),
37            available_since: None,
38        },
39        GroupValue {
40            name: "SDL_MESSAGEBOX_BUTTONS_RIGHT_TO_LEFT",
41            short_name: "BUTTONS_RIGHT_TO_LEFT",
42            doc: Some("buttons placed right to left\n"),
43            available_since: None,
44        },
45    ],
46};
47pub const METADATA_SDL_MessageBoxButtonFlags: Group = Group {
48    module: "messagebox",
49    kind: GroupKind::Flags,
50    name: "SDL_MessageBoxButtonFlags",
51    short_name: "MessageBoxButtonFlags",
52    doc: Some(
53        "[`SDL_MessageBoxButtonData`] flags.\n\n## Availability\nThis datatype is available since SDL 3.2.0.\n",
54    ),
55    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
56    values: &[
57        GroupValue {
58            name: "SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT",
59            short_name: "RETURNKEY_DEFAULT",
60            doc: Some("Marks the default button when return is hit\n"),
61            available_since: None,
62        },
63        GroupValue {
64            name: "SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT",
65            short_name: "ESCAPEKEY_DEFAULT",
66            doc: Some("Marks the default button when escape is hit\n"),
67            available_since: None,
68        },
69    ],
70};
71pub const METADATA_SDL_MessageBoxColorType: Group = Group {
72    module: "messagebox",
73    kind: GroupKind::Enum,
74    name: "SDL_MessageBoxColorType",
75    short_name: "MessageBoxColorType",
76    doc: Some(
77        "An enumeration of indices inside the colors array of\n[`SDL_MessageBoxColorScheme`].\n",
78    ),
79    available_since: None,
80    values: &[
81        GroupValue {
82            name: "SDL_MESSAGEBOX_COLOR_BACKGROUND",
83            short_name: "BACKGROUND",
84            doc: None,
85            available_since: None,
86        },
87        GroupValue {
88            name: "SDL_MESSAGEBOX_COLOR_TEXT",
89            short_name: "TEXT",
90            doc: None,
91            available_since: None,
92        },
93        GroupValue {
94            name: "SDL_MESSAGEBOX_COLOR_BUTTON_BORDER",
95            short_name: "BUTTON_BORDER",
96            doc: None,
97            available_since: None,
98        },
99        GroupValue {
100            name: "SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND",
101            short_name: "BUTTON_BACKGROUND",
102            doc: None,
103            available_since: None,
104        },
105        GroupValue {
106            name: "SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED",
107            short_name: "BUTTON_SELECTED",
108            doc: None,
109            available_since: None,
110        },
111        GroupValue {
112            name: "SDL_MESSAGEBOX_COLOR_COUNT",
113            short_name: "COUNT",
114            doc: Some("Size of the colors array of [`SDL_MessageBoxColorScheme`].\n"),
115            available_since: None,
116        },
117    ],
118};
119pub const METADATA_SDL_MessageBoxButtonData: Struct = Struct {
120    module: "messagebox",
121    kind: StructKind::Struct,
122    name: "SDL_MessageBoxButtonData",
123    doc: Some(
124        "Individual button data.\n\n## Availability\nThis struct is available since SDL 3.2.0.\n",
125    ),
126    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
127    fields: &[
128        Field {
129            name: "flags",
130            doc: None,
131            available_since: None,
132            ty: "SDL_MessageBoxButtonFlags",
133        },
134        Field {
135            name: "buttonID",
136            doc: Some("User defined button id (value returned via [`SDL_ShowMessageBox`])\n"),
137            available_since: None,
138            ty: "::core::ffi::c_int",
139        },
140        Field {
141            name: "text",
142            doc: Some("The UTF-8 button text\n"),
143            available_since: None,
144            ty: "*const ::core::ffi::c_char",
145        },
146    ],
147};
148pub const METADATA_SDL_MessageBoxColor: Struct = Struct {
149    module: "messagebox",
150    kind: StructKind::Struct,
151    name: "SDL_MessageBoxColor",
152    doc: Some(
153        "RGB value used in a message box color scheme\n\n## Availability\nThis struct is available since SDL 3.2.0.\n",
154    ),
155    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
156    fields: &[
157        Field {
158            name: "r",
159            doc: None,
160            available_since: None,
161            ty: "Uint8",
162        },
163        Field {
164            name: "g",
165            doc: None,
166            available_since: None,
167            ty: "Uint8",
168        },
169        Field {
170            name: "b",
171            doc: None,
172            available_since: None,
173            ty: "Uint8",
174        },
175    ],
176};
177pub const METADATA_SDL_MessageBoxColorScheme: Struct = Struct {
178    module: "messagebox",
179    kind: StructKind::Struct,
180    name: "SDL_MessageBoxColorScheme",
181    doc: Some(
182        "A set of colors to use for message box dialogs\n\n## Availability\nThis struct is available since SDL 3.2.0.\n",
183    ),
184    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
185    fields: &[Field {
186        name: "colors",
187        doc: None,
188        available_since: None,
189        ty: "[SDL_MessageBoxColor; SDL_MESSAGEBOX_COLOR_COUNT.0 as ::core::primitive::usize]",
190    }],
191};
192pub const METADATA_SDL_MessageBoxData: Struct = Struct {
193    module: "messagebox",
194    kind: StructKind::Struct,
195    name: "SDL_MessageBoxData",
196    doc: Some(
197        "MessageBox structure containing title, text, window, etc.\n\n## Availability\nThis struct is available since SDL 3.2.0.\n",
198    ),
199    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
200    fields: &[
201        Field {
202            name: "flags",
203            doc: None,
204            available_since: None,
205            ty: "SDL_MessageBoxFlags",
206        },
207        Field {
208            name: "window",
209            doc: Some("Parent window, can be NULL\n"),
210            available_since: None,
211            ty: "*mut SDL_Window",
212        },
213        Field {
214            name: "title",
215            doc: Some("UTF-8 title\n"),
216            available_since: None,
217            ty: "*const ::core::ffi::c_char",
218        },
219        Field {
220            name: "message",
221            doc: Some("UTF-8 message text\n"),
222            available_since: None,
223            ty: "*const ::core::ffi::c_char",
224        },
225        Field {
226            name: "numbuttons",
227            doc: None,
228            available_since: None,
229            ty: "::core::ffi::c_int",
230        },
231        Field {
232            name: "buttons",
233            doc: None,
234            available_since: None,
235            ty: "*const SDL_MessageBoxButtonData",
236        },
237        Field {
238            name: "colorScheme",
239            doc: Some("[`SDL_MessageBoxColorScheme`], can be NULL to use system settings\n"),
240            available_since: None,
241            ty: "*const SDL_MessageBoxColorScheme",
242        },
243    ],
244};