glib/auto/
constants.rs

Help
1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from gir-files (https://github.com/gtk-rs/gir-files)
3// DO NOT EDIT
4
5use crate::{ffi, GStr};
6
7/// The set of uppercase ASCII alphabet characters.
8/// Used for specifying valid identifier characters
9/// in #GScannerConfig.
10#[doc(alias = "G_CSET_A_2_Z")]
11pub static CSET_A_2_Z: &GStr = unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_CSET_A_2_Z) };
12/// The set of ASCII digits.
13/// Used for specifying valid identifier characters
14/// in #GScannerConfig.
15#[doc(alias = "G_CSET_DIGITS")]
16pub static CSET_DIGITS: &GStr = unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_CSET_DIGITS) };
17/// The set of lowercase ASCII alphabet characters.
18/// Used for specifying valid identifier characters
19/// in #GScannerConfig.
20#[doc(alias = "G_CSET_a_2_z")]
21pub static CSET_a_2_z: &GStr = unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_CSET_a_2_z) };
22/// The name of the main group of a desktop entry file, as defined in the
23/// [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/).
24///
25/// Consult the specification for more
26/// details about the meanings of the keys below.
27#[doc(alias = "G_KEY_FILE_DESKTOP_GROUP")]
28pub static KEY_FILE_DESKTOP_GROUP: &GStr =
29    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_GROUP) };
30/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a string list
31/// giving the available application actions.
32#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_ACTIONS")]
33pub static KEY_FILE_DESKTOP_KEY_ACTIONS: &GStr =
34    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_ACTIONS) };
35/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a list
36/// of strings giving the categories in which the desktop entry
37/// should be shown in a menu.
38#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_CATEGORIES")]
39pub static KEY_FILE_DESKTOP_KEY_CATEGORIES: &GStr =
40    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_CATEGORIES) };
41/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a localized
42/// string giving the tooltip for the desktop entry.
43#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_COMMENT")]
44pub static KEY_FILE_DESKTOP_KEY_COMMENT: &GStr =
45    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_COMMENT) };
46/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a boolean
47/// set to true if the application is D-Bus activatable.
48#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE")]
49pub static KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE: &GStr =
50    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE) };
51/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a string
52/// giving the command line to execute.
53///
54/// It is only valid for desktop entries with the `Application` type.
55#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_EXEC")]
56pub static KEY_FILE_DESKTOP_KEY_EXEC: &GStr =
57    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_EXEC) };
58/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a localized
59/// string giving the generic name of the desktop entry.
60#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME")]
61pub static KEY_FILE_DESKTOP_KEY_GENERIC_NAME: &GStr =
62    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_GENERIC_NAME) };
63/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a boolean
64/// stating whether the desktop entry has been deleted by the user.
65#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_HIDDEN")]
66pub static KEY_FILE_DESKTOP_KEY_HIDDEN: &GStr =
67    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_HIDDEN) };
68/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a localized
69/// string giving the name of the icon to be displayed for the desktop
70/// entry.
71#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_ICON")]
72pub static KEY_FILE_DESKTOP_KEY_ICON: &GStr =
73    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_ICON) };
74/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a list
75/// of strings giving the MIME types supported by this desktop entry.
76#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_MIME_TYPE")]
77pub static KEY_FILE_DESKTOP_KEY_MIME_TYPE: &GStr =
78    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_MIME_TYPE) };
79/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a localized
80/// string giving the specific name of the desktop entry.
81#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_NAME")]
82pub static KEY_FILE_DESKTOP_KEY_NAME: &GStr =
83    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_NAME) };
84/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a list of
85/// strings identifying the environments that should not display the
86/// desktop entry.
87#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN")]
88pub static KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN: &GStr =
89    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN) };
90/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a boolean
91/// stating whether the desktop entry should be shown in menus.
92#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY")]
93pub static KEY_FILE_DESKTOP_KEY_NO_DISPLAY: &GStr =
94    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY) };
95/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a list of
96/// strings identifying the environments that should display the
97/// desktop entry.
98#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN")]
99pub static KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN: &GStr =
100    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN) };
101/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a string
102/// containing the working directory to run the program in.
103///
104/// It is only valid for desktop entries with the `Application` type.
105#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_PATH")]
106pub static KEY_FILE_DESKTOP_KEY_PATH: &GStr =
107    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_PATH) };
108/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a boolean
109/// stating whether the application supports the
110/// [Startup Notification Protocol Specification](https://specifications.freedesktop.org/startup-notification-spec/latest/).
111#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY")]
112pub static KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY: &GStr =
113    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY) };
114/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is string
115/// identifying the WM class or name hint of a window that the application
116/// will create, which can be used to emulate
117/// [Startup Notification](https://specifications.freedesktop.org/startup-notification-spec/latest/)
118/// with older applications.
119#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS")]
120pub static KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS: &GStr =
121    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS) };
122/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a boolean
123/// stating whether the program should be run in a terminal window.
124///
125/// It is only valid for desktop entries with the `Application` type.
126#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_TERMINAL")]
127pub static KEY_FILE_DESKTOP_KEY_TERMINAL: &GStr =
128    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_TERMINAL) };
129/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a string
130/// giving the file name of a binary on disk used to determine if the
131/// program is actually installed.
132///
133/// It is only valid for desktop entries with the `Application` type.
134#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_TRY_EXEC")]
135pub static KEY_FILE_DESKTOP_KEY_TRY_EXEC: &GStr =
136    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_TRY_EXEC) };
137/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a string
138/// giving the type of the desktop entry.
139///
140/// Usually `GLib::KEY_FILE_DESKTOP_TYPE_APPLICATION`,
141/// `GLib::KEY_FILE_DESKTOP_TYPE_LINK`, or
142/// `GLib::KEY_FILE_DESKTOP_TYPE_DIRECTORY`.
143#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_TYPE")]
144pub static KEY_FILE_DESKTOP_KEY_TYPE: &GStr =
145    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_TYPE) };
146/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a string
147/// giving the URL to access.
148///
149/// It is only valid for desktop entries with the `Link` type.
150#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_URL")]
151pub static KEY_FILE_DESKTOP_KEY_URL: &GStr =
152    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_URL) };
153/// A key under `GLib::KEY_FILE_DESKTOP_GROUP`, whose value is a string
154/// giving the version of the Desktop Entry Specification used for
155/// the desktop entry file.
156#[doc(alias = "G_KEY_FILE_DESKTOP_KEY_VERSION")]
157pub static KEY_FILE_DESKTOP_KEY_VERSION: &GStr =
158    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_KEY_VERSION) };
159/// The value of the `GLib::KEY_FILE_DESKTOP_KEY_TYPE`, key for desktop
160/// entries representing applications.
161#[doc(alias = "G_KEY_FILE_DESKTOP_TYPE_APPLICATION")]
162pub static KEY_FILE_DESKTOP_TYPE_APPLICATION: &GStr =
163    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_TYPE_APPLICATION) };
164/// The value of the `GLib::KEY_FILE_DESKTOP_KEY_TYPE`, key for desktop
165/// entries representing directories.
166#[doc(alias = "G_KEY_FILE_DESKTOP_TYPE_DIRECTORY")]
167pub static KEY_FILE_DESKTOP_TYPE_DIRECTORY: &GStr =
168    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_TYPE_DIRECTORY) };
169/// The value of the `GLib::KEY_FILE_DESKTOP_KEY_TYPE`, key for desktop
170/// entries representing links to documents.
171#[doc(alias = "G_KEY_FILE_DESKTOP_TYPE_LINK")]
172pub static KEY_FILE_DESKTOP_TYPE_LINK: &GStr =
173    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_KEY_FILE_DESKTOP_TYPE_LINK) };
174/// If a long option in the main group has this name, it is not treated as a
175/// regular option. Instead it collects all non-option arguments which would
176/// otherwise be left in `argv`. The option must be of type
177/// [`OptionArg::Callback`][crate::OptionArg::Callback], [`OptionArg::StringArray`][crate::OptionArg::StringArray]
178/// or [`OptionArg::FilenameArray`][crate::OptionArg::FilenameArray].
179///
180///
181/// Using [`OPTION_REMAINING`][crate::OPTION_REMAINING] instead of simply scanning `argv`
182/// for leftover arguments has the advantage that GOption takes care of
183/// necessary encoding conversions for strings or filenames.
184#[doc(alias = "G_OPTION_REMAINING")]
185pub static OPTION_REMAINING: &GStr =
186    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_OPTION_REMAINING) };
187/// The standard delimiters, used in `strdelimit()`.
188#[doc(alias = "G_STR_DELIMITERS")]
189pub static STR_DELIMITERS: &GStr =
190    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_STR_DELIMITERS) };
191/// A value that can be passed as an option to `test_init()`.
192///
193/// Creates a unique temporary directory for each unit test and uses sets
194/// XDG directories to point into subdirectories of it for the duration of
195/// the unit test. The directory tree is cleaned up after the test finishes
196/// successfully.
197///
198/// Note that this doesn’t take effect until `test_run()` is called,
199/// so calls to (for example) [`home_dir()`][crate::home_dir()] will return the
200/// system-wide value when made in a test program’s main() function.
201///
202/// The following functions will return subdirectories of the temporary directory
203/// when this option is used. The specific subdirectory paths in use are not
204/// guaranteed to be stable API — always use a getter function to retrieve them.
205///
206///  - [`home_dir()`][crate::home_dir()]
207///  - [`user_cache_dir()`][crate::user_cache_dir()]
208///  - [`system_config_dirs()`][crate::system_config_dirs()]
209///  - [`user_config_dir()`][crate::user_config_dir()]
210///  - [`system_data_dirs()`][crate::system_data_dirs()]
211///  - [`user_data_dir()`][crate::user_data_dir()]
212///  - [`user_state_dir()`][crate::user_state_dir()]
213///  - [`user_runtime_dir()`][crate::user_runtime_dir()]
214///
215/// The subdirectories may not be created by the test harness; as with normal
216/// calls to functions like [`user_cache_dir()`][crate::user_cache_dir()], the caller must
217/// be prepared to create the directory if it doesn’t exist.
218#[cfg(feature = "v2_60")]
219#[cfg_attr(docsrs, doc(cfg(feature = "v2_60")))]
220#[doc(alias = "G_TEST_OPTION_ISOLATE_DIRS")]
221pub static TEST_OPTION_ISOLATE_DIRS: &GStr =
222    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_TEST_OPTION_ISOLATE_DIRS) };
223/// A value that can be passed as an option to `test_init()`.
224///
225/// If this option is given, assertions will not abort the process, but
226/// call `test_fail()`. Equivalent to `test_set_nonfatal_assertions()`.
227#[cfg(feature = "v2_84")]
228#[cfg_attr(docsrs, doc(cfg(feature = "v2_84")))]
229#[doc(alias = "G_TEST_OPTION_NONFATAL_ASSERTIONS")]
230pub static TEST_OPTION_NONFATAL_ASSERTIONS: &GStr =
231    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_TEST_OPTION_NONFATAL_ASSERTIONS) };
232/// A value that can be passed as an option to `test_init()`.
233///
234/// If this option is given, `test_init()` will not call `set_prgname()`.
235#[cfg(feature = "v2_84")]
236#[cfg_attr(docsrs, doc(cfg(feature = "v2_84")))]
237#[doc(alias = "G_TEST_OPTION_NO_PRGNAME")]
238pub static TEST_OPTION_NO_PRGNAME: &GStr =
239    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_TEST_OPTION_NO_PRGNAME) };
240/// Generic delimiters characters as defined in
241/// [RFC 3986](https://tools.ietf.org/html/rfc3986). Includes `:/?#[]@`.
242#[doc(alias = "G_URI_RESERVED_CHARS_GENERIC_DELIMITERS")]
243pub static URI_RESERVED_CHARS_GENERIC_DELIMITERS: &GStr =
244    unsafe { GStr::from_utf8_with_nul_unchecked(ffi::G_URI_RESERVED_CHARS_GENERIC_DELIMITERS) };
245/// Subcomponent delimiter characters as defined in
246/// [RFC 3986](https://tools.ietf.org/html/rfc3986). Includes `!$&'()*+,;=`.
247#[doc(alias = "G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS")]
248pub static URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS: &GStr = unsafe {
249    GStr::from_utf8_with_nul_unchecked(ffi::G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS)
250};
glib/auto/constants.rs

glib/auto/
constants.rs
