-<!-- ##### FUNCTION g_date_get_day ##### -->
-<para>\r
-Return the day of the month; the #GDate must be valid.\r
+<!-- ##### SECTION ./tmpl/desktop_entry.sgml:Long_Description ##### -->
+<para>
+The "GDesktopEntry" parser is intended to parse files written to
+the <ulink
+url="http://www.freedesktop.org/Standards/desktop-entry-spec">Desktop
+Entry Specification</ulink>. It supports deserialization of
+desktop entries from files and in-memory data. Desktop entries
+are used for a variety of things including menus, application
+MIME type registration, and launchers.
</para>
-@date: Date to extract the day of the month from
-@Returns: Day of the month
-
-<!-- ##### FUNCTION g_markup_parse_context_parse ##### -->
<para>
+To load an existing desktop entry from a data directory (as
+returned by g_get_user_data_dir() and g_get_system_data_dirs())
+use g_desktop_entry_new_from_data_dirs(). To load an existing
+desktop entry from an arbitrary location on the file system use
+g_desktop_entry_new_from_file(). If the desktop entry is already
+in memory use g_desktop_entry_new_from_data(). Once the desktop
+entry is loaded its keys can be queried using the g_desktop_entry_get
+family of functions.
+</para>
+<para>
+To create a new desktop entry first call g_desktop_entry_new().
+Then, call the g_desktop_entry_set family of functions. Next,
+call g_desktop_entry_to_data() to output the desktop entry to
+a byte array, which can be written to disk or sent over a
+network. Finally, call g_desktop_entry_free() to deallocate the
+#GDesktopEntry object returned by g_desktop_entry_new().
</para>
-@context:
-@text:
-@text_len:
-@error:
-@Returns:
-<!-- ##### STRUCT GSource ##### -->
+<!-- ##### SECTION ./tmpl/desktop_entry.sgml:See_Also ##### -->
<para>
</para>
-<!-- ##### FUNCTION g_source_connect_indirect ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/desktop_entry.sgml:Short_Description ##### -->
+serializes and deserializes a desktop entry.
-</para>
-@source:
-@callback_data:
-@callback_funcs:
+<!-- ##### SECTION ./tmpl/desktop_entry.sgml:Title ##### -->
+Desktop Entry Parser
-<!-- ##### FUNCTION g_date_get_sunday_weeks_in_year ##### -->
-<para>\r
-Return the number of weeks in the year, where weeks are taken to start\r
-on Sunday. Will be 52 or 53. Date must be valid. (Years always have 52\r
-7-day periods, plus 1 or 2 extra days depending on whether it's a leap\r
-year. This function is basically telling you how many Sundays are in\r
-the year, i.e. there are 53 Sundays if one of the extra days happens\r
-to be a Sunday.)\r
-</para>
-@year: Year to count weeks in
-@Returns: Number of weeks
+<!-- ##### SECTION ./tmpl/glib-unused.sgml:Stability_Level ##### -->
-<!-- ##### FUNCTION g_locale_to_utf8 ##### -->
+
+
+<!-- ##### SECTION ./tmpl/testutils.sgml:Long_Description ##### -->
<para>
</para>
-@opsysstring:
-@error:
-@Returns:
-<!-- ##### FUNCTION g_iconv_close ##### -->
+<!-- ##### SECTION ./tmpl/testutils.sgml:See_Also ##### -->
<para>
</para>
-@converter:
-@Returns:
-<!-- ##### MACRO popen ##### -->
+<!-- ##### SECTION ./tmpl/testutils.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/testutils.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/testutils.sgml:Title ##### -->
+Testing
+
+
+<!-- ##### ENUM GChannelError ##### -->
<para>
</para>
+@G_CHANNEL_ERROR_ACCES:
+@G_CHANNEL_ERROR_BADF:
+@G_CHANNEL_ERROR_DEADLK:
+@G_CHANNEL_ERROR_FAULT:
+@G_CHANNEL_ERROR_INVAL:
+@G_CHANNEL_ERROR_IO:
+@G_CHANNEL_ERROR_ISDIR:
+@G_CHANNEL_ERROR_MFILE:
+@G_CHANNEL_ERROR_NOLCK:
+@G_CHANNEL_ERROR_NOSPC:
+@G_CHANNEL_ERROR_PERM:
+@G_CHANNEL_ERROR_PIPE:
+@G_CHANNEL_ERROR_SPIPE:
+@G_CHANNEL_ERROR_ENCODE_RW:
+@G_CHANNEL_ERROR_FAILED:
-<!-- ##### FUNCTION g_source_set_can_recurse ##### -->
+<!-- ##### ENUM GChannelStatus ##### -->
<para>
</para>
-@source:
-@can_recurse:
+@G_CHANNEL_STATUS_NORMAL:
+@G_CHANNEL_STATUS_EOF:
+@G_CHANNEL_STATUS_PARTIAL_CHARS:
+@G_CHANNEL_STATUS_AGAIN:
+@G_CHANNEL_STATUS_INTR:
+@G_CHANNEL_STATUS_ERROR:
+@G_CHANNEL_STATUS_BAD_INPUT:
+
+<!-- ##### USER_FUNCTION GCompareFuncData ##### -->
+<para>
-<!-- ##### FUNCTION g_date_get_days_in_month ##### -->
-<para>\r
-Return the number of days in a month, taking leap years into account.\r
</para>
-@month: Month
-@year: Year
-@Returns: Number of days in @month during the year @year.
+@a:
+@b:
+@user_data:
+@Returns:
+
+<!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
+<para>
-<!-- ##### FUNCTION g_date_get_julian ##### -->
-<para>\r
-Accessor, returns the Julian day or "serial number" of the #GDate. The\r
-Julian day is simply the number of days since January 1, Year 1; i.e.,\r
-January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2,\r
-etc. Date must be valid.\r
</para>
-@date: Date to extract the Julian day from
-@Returns: Julian day
+@s1:
+@s2:
+@Returns:
-<!-- ##### MACRO pclose ##### -->
+<!-- ##### STRUCT GDesktopEntry ##### -->
<para>
</para>
-<!-- ##### FUNCTION g_main_add_poll ##### -->
+<!-- ##### ENUM GDesktopEntryError ##### -->
<para>
-Adds a file descriptor to be polled.
-This is usually combined with g_source_add() to add an event source.
-The event source's check function will typically test the revents
-field in the #GPollFD struct and return TRUE if events need to be processed.
+Error codes returned by desktop entry parsing.
</para>
-@fd: a #GPollFD, which is a file descriptor together with a bitwise
-combination of #GIOCondition flags determining which events to poll for.
-@priority: the priority of the poll, which should be the same as the priority
-used for g_source_add() to ensure that the file descriptor is polled whenever
-the results may be needed.
-See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
-#G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
+@G_DESKTOP_ENTRY_ERROR_UNKNOWN_ENCODING: text being parsed is not UTF-8 and
+cannot be guessed.
+@G_DESKTOP_ENTRY_ERROR_BAD_START_GROUP: desktop entry does not start with a
+legal start group.
+@G_DESKTOP_ENTRY_ERROR_PARSE: desktop entry is empty or contains invalid
+data.
+@G_DESKTOP_ENTRY_ERROR_NOT_FOUND: valid desktop entry could not be found.
+@G_DESKTOP_ENTRY_ERROR_KEY_NOT_FOUND: desktop entry does not have requested
+key.
+@G_DESKTOP_ENTRY_ERROR_GROUP_NOT_FOUND: desktop entry does not have requested
+group
+@G_DESKTOP_ENTRY_ERROR_INVALID_VALUE: desktop entry contains key which has
+value that cannot be validated.
-<!-- ##### ENUM GMarkupError ##### -->
+<!-- ##### ENUM GDesktopEntryFlags ##### -->
<para>
+#GDesktopEntry supports a few flags for tweaking performance during
+deserialization. #G_DESKTOP_ENTRY_DISCARD_COMMENTS and
+#G_DESKTOP_ENTRY_DISCARD_TRANSLATIONS will reduce memory footprint,
+and #G_DESKTOP_ENTRY_GENERATE_LOOKUP_MAP will increase key lookup speed.
+</para>
+
+@G_DESKTOP_ENTRY_NONE: use parser defaults
+@G_DESKTOP_ENTRY_DISCARD_COMMENTS: Discard all lines that are blank
+or start with "#".
+@G_DESKTOP_ENTRY_DISCARD_TRANSLATIONS: Only retain translations that
+are returned by g_get_language_names().
+@G_DESKTOP_ENTRY_GENERATE_LOOKUP_MAP: Generate a lookup map for key names to make lookups constant time at the cost of more memory.
+<!-- ##### USER_FUNCTION GErrorFunc ##### -->
+<para>
+Specifies the type of function passed to g_set_error_handler().
</para>
-@G_MARKUP_ERROR_BAD_UTF8: text being parsed was not valid UTF-8
-@G_MARKUP_ERROR_EMPTY: document contained nothing, or only whitespace
-@G_MARKUP_ERROR_PARSE: document was ill-formed
-@G_MARKUP_ERROR_UNKNOWN_ELEMENT: error should be set by #GMarkupParser functions; element wasn't known
-@G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE: error should be set by #GMarkupParser functions; attribute wasn't known
-@G_MARKUP_ERROR_INVALID_CONTENT: error should be set by #GMarkupParser functions; something was wrong with contents of the document, e.g. invalid attribute value
+@str: the error message.
-<!-- ##### FUNCTION g_main_context_add_poll ##### -->
+<!-- ##### USER_FUNCTION GHookFreeFunc ##### -->
<para>
</para>
-@context:
-@fd:
-@priority:
+@hook_list:
+@hook:
-<!-- ##### MACRO lseek ##### -->
+<!-- ##### ENUM GIOFileMode ##### -->
<para>
</para>
+@G_IO_FILE_MODE_READ:
+@G_IO_FILE_MODE_WRITE:
+@G_IO_FILE_MODE_APPEND:
+@G_IO_FILE_MODE_READ_WRITE:
+@G_IO_FILE_MODE_READ_WRITE_TRUNCATE:
+@G_IO_FILE_MODE_READ_WRITE_APPEND:
-<!-- ##### FUNCTION g_string_new_len ##### -->
+<!-- ##### ENUM GMatchType ##### -->
<para>
+Enumeration representing different kinds of patterns. This is only used
+internally for optimizing the match algorithm.
+</para>
+@G_MATCH_ALL: a general pattern.
+@G_MATCH_ALL_TAIL: a general pattern which contains a fixed part matching
+the end of the string.
+@G_MATCH_HEAD: a pattern matching every string with a certain prefix.
+@G_MATCH_TAIL: a pattern matching every string with a certain suffix.
+@G_MATCH_EXACT: a pattern matching exactly one string.
+@G_MATCH_LAST:
+
+<!-- ##### USER_FUNCTION GWarningFunc ##### -->
+<para>
+Specifies the type of function passed to g_set_warning_handler().
</para>
-@init:
-@len:
-@Returns:
+@str: the warning message.
-<!-- ##### STRUCT GSourceCallbackFuncs ##### -->
+<!-- ##### MACRO G_CHANNEL_ERROR ##### -->
<para>
</para>
-@ref:
-@unref:
-@get:
-<!-- ##### FUNCTION g_array_sort ##### -->
+<!-- ##### MACRO G_DESKTOP_ENTRY_ERROR ##### -->
<para>
-
+Error domain for desktop entry parsing. Errors in this domain will
+be from the #GDesktopEntryError enumeration. See #GError for information on
+error domains.
</para>
-@array:
-@compare_func:
-<!-- ##### FUNCTION g_main_context_find_source_by_funcs_user_data ##### -->
+<!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### -->
<para>
</para>
-@context:
-@funcs:
-@user_data:
-@Returns:
-@source_data:
-<!-- ##### FUNCTION g_markup_parse_context_free ##### -->
+<!-- ##### MACRO G_IO_CHANNEL_DEFAULT_LINE_TERM ##### -->
<para>
-
+One of %G_IO_CHANNEL_UNIX_LINE_TERM, %G_IO_CHANNEL_DOS_LINE_TERM,
+or %G_IO_CHANNEL_MACINTOSH_LINE_TERM (unimplemented)
+depending on the system type.
</para>
-@context:
-<!-- ##### STRUCT GMarkupParseContext ##### -->
+<!-- ##### MACRO G_IO_CHANNEL_DOS_LINE_TERM ##### -->
<para>
</para>
-<!-- ##### FUNCTION g_ptr_array_sort ##### -->
+<!-- ##### MACRO G_IO_CHANNEL_ENCODE_RAW ##### -->
<para>
-
+Encoding for nonbuffered IO. With this encoding, data must be
+read using g_io_channel_read_chars(); the other functions will
+not work.
</para>
-@array:
-@compare_func:
-<!-- ##### FUNCTION g_main_context_query ##### -->
+<!-- ##### MACRO G_IO_CHANNEL_MACINTOSH_LINE_TERM ##### -->
<para>
</para>
-@context:
-@max_priority:
-@timeout:
-@fds:
-@n_fds:
-@Returns:
-<!-- ##### FUNCTION g_iconv_open ##### -->
+<!-- ##### MACRO G_IO_CHANNEL_UNIX_LINE_TERM ##### -->
<para>
</para>
-@to_codeset:
-@from_codeset:
-@Returns:
-<!-- ##### FUNCTION g_source_new ##### -->
+<!-- ##### MACRO NAME_MAX ##### -->
<para>
-
+Provided for UNIX emulation on Windows; equivalent to UNIX macro
+%NAME_MAX, which is the maximum length of a single path component.
+i.e. just the <filename>foo</filename> in <filename>/usr/bin/foo</filename>.
</para>
-@source_funcs:
-@struct_size:
-@Returns:
-<!-- ##### FUNCTION g_date_get_monday_week_of_year ##### -->
-<para>\r
-Return the week of the year, where weeks are understood to start on\r
-Monday. If the date is before the first Monday of the year, return\r
-0. Date must be valid.\r
+<!-- ##### MACRO _ ##### -->
+<para>
+Marks a string for translation, gets replaced with the translated string
+at runtime.
</para>
-@date: Date to use
-@Returns: Week of the year
+@String: the string to be translated
+@Since: 2.4
-<!-- ##### MACRO getpid ##### -->
+<!-- ##### MACRO access ##### -->
<para>
</para>
-<!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
+<!-- ##### MACRO close ##### -->
<para>
-Removes the first event source found with the given source data.
+
</para>
+
+
+<!-- ##### FUNCTION closedir ##### -->
<para>
-Event sources are sorted with the highest priority first. Sources with equal
-priority are stored in the order in which they were added.
+Provided for UNIX emulation on Windows; see documentation for <function>closedir()</function>
+in any UNIX manual.
</para>
-@source_data: the source data, which contains information specific to the
-type of source.
-@Returns: TRUE if an event source was found and removed.
+@Param1:
+@Returns:
-<!-- ##### MACRO close ##### -->
+<!-- ##### MACRO fdopen ##### -->
<para>
</para>
-<!-- ##### FUNCTION g_source_get_id ##### -->
+<!-- ##### MACRO ftruncate ##### -->
+<para>
+Provided for UNIX emulation on Windows; see documentation for ftruncate()
+in any UNIX manual.
+</para>
+
+@fd:
+@size:
+
+<!-- ##### FUNCTION g_channel_error_from_errno ##### -->
<para>
</para>
-@source:
+@en:
@Returns:
-<!-- ##### FUNCTION g_date_get_year ##### -->
-<para>\r
-Accessor; returns the year of a #GDate. The date must be valid.\r
+<!-- ##### FUNCTION g_channel_error_quark ##### -->
+<para>
+
</para>
-@date: Date
-@Returns: Year in which the date falls
+@Returns:
-<!-- ##### FUNCTION g_mkstemp ##### -->
+<!-- ##### FUNCTION g_convert_error_quark ##### -->
<para>
</para>
-@tmpl:
@Returns:
-<!-- ##### FUNCTION g_date_get_month ##### -->
-<para>\r
-Accessor for the month of the year. Date must be valid.\r
+<!-- ##### FUNCTION g_desktop_entry_escape_strings ##### -->
+<para>
+
</para>
-@date: Date to get the month from
-@Returns: A #GDateMonth
+@entry:
+@should_escape:
-<!-- ##### FUNCTION g_main_context_get_poll_func ##### -->
+<!-- ##### FUNCTION g_desktop_entry_free ##### -->
<para>
</para>
-@context:
-@Returns:
+@entry:
-<!-- ##### FUNCTION g_source_add_poll ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_boolean ##### -->
<para>
</para>
-@source:
-@fd:
+@entry:
+@group_name:
+@key:
+@error:
+@Returns:
-<!-- ##### MACRO fdopen ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_boolean_list ##### -->
<para>
</para>
+@entry:
+@group_name:
+@key:
+@length:
+@error:
+@Returns:
-<!-- ##### USER_FUNCTION GCompletionStrcmpFunc ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_groups ##### -->
<para>
</para>
-@s1:
-@s2:
+@entry:
+@length:
@Returns:
-<!-- ##### FUNCTION g_source_get_current_time ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_integer ##### -->
<para>
</para>
-@source:
-@timeval:
+@entry:
+@group_name:
+@key:
+@error:
+@Returns:
-<!-- ##### FUNCTION g_main_loop_new ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_integer_list ##### -->
<para>
</para>
-@context:
-@is_running:
+@entry:
+@group_name:
+@key:
+@length:
+@error:
@Returns:
-<!-- ##### FUNCTION g_iconv ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_keys ##### -->
<para>
</para>
-@converter:
-@inbuf:
-@inbytes_left:
-@outbuf:
-@outbytes_left:
+@entry:
+@group_name:
+@length:
+@error:
@Returns:
-<!-- ##### FUNCTION g_source_ref ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_locale_string ##### -->
<para>
</para>
-@source:
+@entry:
+@group_name:
+@key:
+@locale:
+@error:
@Returns:
-<!-- ##### FUNCTION g_byte_array_sort ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_locale_string_list ##### -->
<para>
</para>
-@array:
-@compare_func:
+@entry:
+@group_name:
+@key:
+@locale:
+@length:
+@error:
+@Returns:
-<!-- ##### MACRO G_MODULE_SUFFIX ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_start_group ##### -->
<para>
-Expands to the proper shared library suffix for the current platform
-without the leading dot. For the most Unices and Linux this is "so",
-for some HPUX versions this is "sl" and for Windows this is "dll".
+
</para>
+@entry:
+@Returns:
-<!-- ##### FUNCTION g_markup_parse_context_get_position ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_string ##### -->
<para>
</para>
-@context:
-@line_number:
-@char_number:
+@entry:
+@group_name:
+@key:
+@error:
+@Returns:
-<!-- ##### FUNCTION g_locale_from_utf8 ##### -->
+<!-- ##### FUNCTION g_desktop_entry_get_string_list ##### -->
<para>
</para>
-@utf8string:
+@entry:
+@group_name:
+@key:
+@length:
@error:
@Returns:
-<!-- ##### FUNCTION g_main_loop_is_running ##### -->
+<!-- ##### FUNCTION g_desktop_entry_has_group ##### -->
<para>
</para>
-@loop:
+@entry:
+@group_name:
@Returns:
-<!-- ##### FUNCTION g_main_context_remove_poll ##### -->
+<!-- ##### FUNCTION g_desktop_entry_has_key ##### -->
<para>
</para>
-@context:
-@fd:
+@entry:
+@group_name:
+@key:
+@error:
+@Returns:
-<!-- ##### FUNCTION g_byte_array_sort_with_data ##### -->
+<!-- ##### FUNCTION g_desktop_entry_new ##### -->
<para>
</para>
-@array:
-@compare_func:
-@user_data:
+@flags:
+@error:
+@Returns:
-<!-- ##### FUNCTION g_markup_parse_context_new ##### -->
+<!-- ##### FUNCTION g_desktop_entry_new_from_data ##### -->
<para>
</para>
-@parser:
+@data:
+@length:
+@legal_start_groups:
@flags:
-@user_data:
-@user_data_dnotify:
+@error:
@Returns:
-<!-- ##### FUNCTION g_source_get_can_recurse ##### -->
+<!-- ##### FUNCTION g_desktop_entry_new_from_data_dirs ##### -->
<para>
</para>
-@source:
+@file:
+@full_path:
+@legal_start_groups:
+@flags:
+@error:
@Returns:
-<!-- ##### FUNCTION g_main_context_get ##### -->
+<!-- ##### FUNCTION g_desktop_entry_new_from_file ##### -->
<para>
</para>
-@thread:
+@file:
+@legal_start_groups:
+@flags:
+@error:
@Returns:
-<!-- ##### FUNCTION g_source_remove_poll ##### -->
+<!-- ##### FUNCTION g_desktop_entry_remove_group ##### -->
<para>
</para>
-@source:
-@fd:
+@entry:
+@group_name:
+@error:
+
+<!-- ##### FUNCTION g_desktop_entry_remove_key ##### -->
+<para>
-<!-- ##### FUNCTION g_date_get_day_of_year ##### -->
-<para>\r
-Return the day of the year, where Jan 1 is the first day of the\r
-year. Date must be valid.\r
</para>
-@date: Date to extract day of year from
-@Returns: Day of the year
+@entry:
+@group_name:
+@key:
+@error:
-<!-- ##### FUNCTION g_tree_new_with_data ##### -->
+<!-- ##### FUNCTION g_desktop_entry_set_boolean ##### -->
<para>
</para>
-@key_compare_func:
-@user_data:
-@Returns:
+@entry:
+@group_name:
+@key:
+@boolean:
+@error:
-<!-- ##### FUNCTION g_source_get_priority ##### -->
+<!-- ##### FUNCTION g_desktop_entry_set_boolean_list ##### -->
<para>
</para>
-@source:
-@Returns:
+@entry:
+@group_name:
+@key:
+@list:
+@length:
+@error:
-<!-- ##### FUNCTION g_source_connect ##### -->
+<!-- ##### FUNCTION g_desktop_entry_set_integer ##### -->
<para>
</para>
-@source:
-@func:
-@data:
-@notify:
+@entry:
+@group_name:
+@key:
+@integer:
+@error:
-<!-- ##### FUNCTION g_main_context_iteration ##### -->
+<!-- ##### FUNCTION g_desktop_entry_set_integer_list ##### -->
<para>
</para>
-@context:
-@may_block:
-@Returns:
+@entry:
+@group_name:
+@key:
+@list:
+@length:
+@error:
-<!-- ##### FUNCTION g_main_context_dispatch ##### -->
+<!-- ##### FUNCTION g_desktop_entry_set_locale_string ##### -->
<para>
</para>
-@context:
+@entry:
+@group_name:
+@key:
+@locale:
+@string:
+@error:
-<!-- ##### FUNCTION g_main_loop_quit ##### -->
+<!-- ##### FUNCTION g_desktop_entry_set_locale_string_list ##### -->
<para>
</para>
-@loop:
+@entry:
+@group_name:
+@key:
+@locale:
+@list:
+@length:
+@error:
-<!-- ##### FUNCTION g_main_context_prepare ##### -->
+<!-- ##### FUNCTION g_desktop_entry_set_string ##### -->
<para>
</para>
-@context:
-@priority:
-@Returns:
+@entry:
+@group_name:
+@key:
+@string:
+@error:
+
+<!-- ##### FUNCTION g_desktop_entry_set_string_list ##### -->
+<para>
-<!-- ##### FUNCTION g_date_get_sunday_week_of_year ##### -->
-<para>\r
-Week of the year during which this date falls, if weeks are understood\r
-to being on Sunday. Date must be valid. Can return 0 if the day is\r
-before the first Sunday of the year.\r
</para>
-@date: Date
-@Returns: Week number
+@entry:
+@group_name:
+@key:
+@list:
+@length:
+@error:
-<!-- ##### FUNCTION g_source_set_priority ##### -->
+<!-- ##### FUNCTION g_desktop_entry_to_data ##### -->
<para>
</para>
-@source:
-@priority:
+@entry:
+@length:
+@error:
+@Returns:
-<!-- ##### FUNCTION g_ptr_array_sort_with_data ##### -->
+<!-- ##### FUNCTION g_file_replace ##### -->
<para>
</para>
-@array:
-@compare_func:
-@user_data:
+@filename:
+@contents:
+@length:
+@error:
+@Returns:
-<!-- ##### FUNCTION g_list_sort_with_data ##### -->
+<!-- ##### FUNCTION g_format_file_size_for_display ##### -->
<para>
</para>
-@list:
-@compare_func:
-@user_data:
+@size:
@Returns:
-<!-- ##### FUNCTION g_date_get_monday_weeks_in_year ##### -->
-<para>\r
-Return the number of weeks in the year, where weeks are taken to start\r
-on Monday. Will be 52 or 53. Date must be valid. (Years always have 52\r
-7-day periods, plus 1 or 2 extra days depending on whether it's a leap\r
-year. This function is basically telling you how many Mondays are in\r
-the year, i.e. there are 53 Mondays if one of the extra days happens\r
-to be a Monday.)\r
+<!-- ##### FUNCTION g_io_channel_error_quark ##### -->
+<para>
+
</para>
-@year: Year
-@Returns: Number of Mondays in the year
+@Returns:
-<!-- ##### FUNCTION g_main_context_find_source_by_user_data ##### -->
+<!-- ##### VARIABLE g_log_domain_glib ##### -->
<para>
+The log domain used for messages logged by GLib itself.
+</para>
+
+<!-- ##### FUNCTION g_main_add_poll ##### -->
+<para>
+Adds a file descriptor to be polled.
+This is usually combined with g_source_add() to add an event source.
+The event source's check function will typically test the revents
+field in the #GPollFD struct and return TRUE if events need to be processed.
</para>
-@context:
-@user_data:
-@Returns:
+@fd: a #GPollFD, which is a file descriptor together with a bitwise
+combination of #GIOCondition flags determining which events to poll for.
+@priority: the priority of the poll, which should be the same as the priority
+used for g_source_add() to ensure that the file descriptor is polled whenever
+the results may be needed.
+See #G_PRIORITY_DEFAULT, #G_PRIORITY_DEFAULT_IDLE, #G_PRIORITY_HIGH,
+#G_PRIORITY_HIGH_IDLE, and #G_PRIORITY_LOW.
-<!-- ##### FUNCTION g_main_context_set_poll_func ##### -->
+<!-- ##### FUNCTION g_main_context_get ##### -->
<para>
</para>
-@context:
-@func:
+@thread:
+@Returns:
-<!-- ##### MACRO getcwd ##### -->
+<!-- ##### FUNCTION g_main_loop_destroy ##### -->
<para>
</para>
+@loop:
-<!-- ##### MACRO g_rand_boolean ##### -->
+<!-- ##### FUNCTION g_main_remove_poll ##### -->
<para>
-Return a random #gboolean from @rand. This corresponds to a unbiased
-coin toss.
+Removes a file descriptor from the list being polled.
</para>
-@rand: a #GRand.
-@Returns: a random #gboolean.
+@fd: the #GPollFD to remove.
-<!-- ##### FUNCTION g_io_create_watch ##### -->
+<!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
<para>
</para>
-@channel:
-@condition:
@Returns:
-<!-- ##### FUNCTION g_source_unref ##### -->
+<!-- ##### FUNCTION g_mem_check ##### -->
<para>
-
+Checks if the given memory has already been freed. If it has it outputs
+a warning message.
+To use this function you must configure glib with the flag
+'--enable-mem-check=yes' before compiling.
</para>
-@source:
+@mem: the memory to check.
-<!-- ##### MACRO write ##### -->
+<!-- ##### FUNCTION g_regex_error_quark ##### -->
<para>
</para>
+@Returns:
-<!-- ##### FUNCTION g_main_context_find_source_by_id ##### -->
+<!-- ##### FUNCTION g_regex_free ##### -->
<para>
</para>
-@context:
-@id:
-@Returns:
+@regex:
-<!-- ##### FUNCTION g_main_remove_poll ##### -->
+<!-- ##### FUNCTION g_scanner_stat_mode ##### -->
<para>
-Removes a file descriptor from the list being polled.
+Gets the file attributes.
+This is the <structfield>st_mode</structfield> field from the
+<structname>stat</structname> structure. See the <function>stat()</function>
+documentation.
</para>
-@fd: the #GPollFD to remove.
+@filename: the file name.
+@Returns: the file attributes.
-<!-- ##### MACRO access ##### -->
+<!-- ##### FUNCTION g_set_error_handler ##### -->
<para>
-
+Sets the function to be called to handle error messages.
+This function is deprecated in favour of the new logging facilities.
</para>
+@func: the function to be called to handle error messages.
+@Returns: the old error handler.
-<!-- ##### FUNCTION g_idle_source_new ##### -->
+<!-- ##### FUNCTION g_set_message_handler ##### -->
<para>
-
+Sets the function to be called to handle messages.
+This function is deprecated in favour of the new logging facilities.
</para>
-@Returns:
+@func: the function to be called to handle normal messages.
+@Returns: the old message handler.
-<!-- ##### MACRO g_string ##### -->
+<!-- ##### FUNCTION g_set_warning_handler ##### -->
<para>
-Turns the argument into a string literal by using the '#' stringizing operator.
+Sets the function to be called to handle warning messages.
+This function is deprecated in favour of the new logging facilities.
</para>
-@x: text to convert to a literal string.
+@func: the function to be called to handle warning messages.
+@Returns: the old warning handler.
-<!-- ##### FUNCTION g_main_context_pending ##### -->
+<!-- ##### FUNCTION g_source_add ##### -->
<para>
-
</para>
-@context:
+@priority:
+@can_recurse:
+@funcs:
+@source_data:
+@user_data:
+@notify:
@Returns:
+@source:
+@context:
-<!-- ##### FUNCTION g_main_win32_get_poll_func ##### -->
+<!-- ##### FUNCTION g_source_connect ##### -->
<para>
</para>
-@Returns:
+@source:
+@func:
+@data:
+@notify:
-<!-- ##### FUNCTION g_main_loop_run ##### -->
+<!-- ##### FUNCTION g_source_connect_indirect ##### -->
<para>
</para>
-@loop:
+@source:
+@callback_data:
+@callback_funcs:
-<!-- ##### FUNCTION g_date_get_weekday ##### -->
-<para>\r
-Returns the day of the week for a #GDate. The date must be valid.\r
+<!-- ##### FUNCTION g_source_remove_by_source_data ##### -->
+<para>
+Removes the first event source found with the given source data.
+</para>
+<para>
+Event sources are sorted with the highest priority first. Sources with equal
+priority are stored in the order in which they were added.
</para>
-@date: Date
-@Returns: Day of the week as a #GDateWeekday
+@source_data: the source data, which contains information specific to the
+type of source.
+@Returns: TRUE if an event source was found and removed.
-<!-- ##### MACRO read ##### -->
+<!-- ##### FUNCTION g_static_private_get_for_thread ##### -->
<para>
</para>
+@private_key:
+@thread:
+@Returns:
-<!-- ##### FUNCTION g_array_sort_with_data ##### -->
+<!-- ##### FUNCTION g_static_private_set_for_thread ##### -->
<para>
</para>
-@array:
-@compare_func:
-@user_data:
+@private_key:
+@thread:
+@data:
+@notify:
-<!-- ##### MACRO G_MARKUP_ERROR ##### -->
+<!-- ##### MACRO g_string ##### -->
+<para>
+Turns the argument into a string literal by using the '#' stringizing operator.
+</para>
+
+@x: text to convert to a literal string.
+
+<!-- ##### FUNCTION g_warn_message ##### -->
<para>
</para>
+@domain:
+@file:
+@line:
+@func:
+@warnexpr:
-<!-- ##### FUNCTION g_main_context_default ##### -->
+<!-- ##### MACRO getcwd ##### -->
<para>
</para>
-@Returns:
-<!-- ##### ENUM GMarkupParseFlags ##### -->
+<!-- ##### MACRO getpid ##### -->
<para>
-There are no flags right now
+
</para>
-@G_MARKUP_DO_NOT_USE_THIS_UNSUPPORTED_FLAG:
-<!-- ##### MACRO g_random_boolean ##### -->
+<!-- ##### VARIABLE glib_binary_age ##### -->
<para>
-Return a random #gboolean. This corresponds to a unbiased coin toss.
+This is the binary age passed to <application>libtool</application>. If
+<application>libtool</application> means nothing to you, don't worry
+about it. ;-)
</para>
-@Returns: a random #gboolean.
-<!-- ##### FUNCTION g_slist_sort_with_data ##### -->
+<!-- ##### FUNCTION glib_check_version ##### -->
<para>
</para>
-@list:
-@compare_func:
-@user_data:
+@required_major:
+@required_minor:
+@required_micro:
@Returns:
-<!-- ##### FUNCTION g_markup_parse_context_end_parse ##### -->
+<!-- ##### VARIABLE glib_interface_age ##### -->
<para>
-
+This is the interface age passed to <application>libtool</application>. If
+<application>libtool</application> means nothing to you, don't worry
+about it. ;-)
</para>
-@context:
-@error:
-@Returns:
-<!-- ##### FUNCTION g_source_get_context ##### -->
+<!-- ##### VARIABLE glib_major_version ##### -->
<para>
+The major version number of the GLib library.
+(e.g. in GLib version 1.2.5 this is 1.)
+</para>
+<para>
+This variable is in the library, so represents the
+GLib library you have linked against. Contrast with the
+#GLIB_MAJOR_VERSION macro, which represents the major version of the
+GLib headers you have included.
</para>
-@source:
-@Returns:
-<!-- ##### FUNCTION g_timeout_source_new ##### -->
+<!-- ##### VARIABLE glib_micro_version ##### -->
<para>
+The micro version number of the GLib library.
+(e.g. in GLib version 1.2.5 this is 5.)
+</para>
+<para>
+This variable is in the library, so represents the GLib library you
+have linked against. Contrast with the #GLIB_MICRO_VERSION macro, which
+represents the micro version of the GLib headers you have included.
</para>
-@interval:
-@Returns:
-<!-- ##### STRUCT GMarkupParser ##### -->
+<!-- ##### VARIABLE glib_minor_version ##### -->
<para>
-Any of the fields in #GMarkupParser can be %NULL, in which case they
-will be ignored. Except for the @error function, any of these
-callbacks can set an error; in particular the
-%G_MARKUP_ERROR_UNKNOWN_ELEMENT, %G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
-and %G_MARKUP_ERROR_INVALID_CONTENT errors are intended to be set
-from these callbacks. If you set an error from a callback,
-g_markup_parse_context_parse() will report that error back to its caller.
+The minor version number of the GLib library.
+(e.g. in GLib version 1.2.5 this is 2.)
</para>
-@start_element: Callback to invoke when the opening tag of an element
-is seen.
-@end_element: Callback to invoke when the closing tag of an element is seen
-@text: Callback to invoke when some text is seen (text is always
-inside an element)
-@passthrough: Callback to invoke for comments and processing
-instructions; if you're re-writing the parsed document, write the
-passthrough text back out in the same position
-@error: Callback to invoke when an error occurs
-
-<!-- ##### USER_FUNCTION GEqualFunc ##### -->
<para>
-Specifies the type of a function used to test two values for
-equality. The function should return TRUE if both values are equal and
-FALSE otherwise.
+This variable is in the library, so represents the
+GLib library you have linked against. Contrast with the
+#GLIB_MINOR_VERSION macro, which represents the minor version of the
+GLib headers you have included.
</para>
-@a: a value.
-@b: a value to compare with.
-@Returns: TRUE if @a = @b; FALSE otherwise.
-<!-- ##### FUNCTION g_main_loop_destroy ##### -->
+<!-- ##### MACRO lseek ##### -->
<para>
</para>
-@loop:
-<!-- ##### FUNCTION g_file_open_tmp ##### -->
+<!-- ##### MACRO open ##### -->
<para>
</para>
-@tmpl:
-@name_used:
-@error:
+
+<!-- ##### FUNCTION opendir ##### -->
+<para>
+Provided for UNIX emulation on Windows; see documentation for <function>opendir()</function>
+in any UNIX manual.
+</para>
+
+@Param1:
@Returns:
-<!-- ##### STRUCT GMainContext ##### -->
+<!-- ##### MACRO pclose ##### -->
<para>
</para>
-<!-- ##### FUNCTION g_main_context_check ##### -->
+<!-- ##### MACRO pipe ##### -->
<para>
-
+Provided for UNIX emulation on Windows; see documentation for pipe()
+in any UNIX manual.
</para>
-@context:
-@max_priority:
-@fds:
-@n_fds:
-@Returns:
+@phandles: file descriptors, the first one for reading, the second one for writing.
-<!-- ##### FUNCTION g_convert_error_quark ##### -->
+<!-- ##### MACRO popen ##### -->
<para>
</para>
-@Returns:
-<!-- ##### FUNCTION g_source_destroy ##### -->
+<!-- ##### MACRO read ##### -->
<para>
</para>
-@source:
-<!-- ##### FUNCTION g_markup_escape_text ##### -->
+<!-- ##### MACRO readdir ##### -->
<para>
+Provided for UNIX emulation on Windows; see documentation for <function>readdir()</function>
+in any UNIX manual.
+</para>
+
+<!-- ##### FUNCTION rewinddir ##### -->
+<para>
+Provided for UNIX emulation on Windows; see documentation for <function>rewinddir()</function>
+in any UNIX manual.
</para>
-@text:
-@length:
-@Returns:
+@Param1:
-<!-- ##### MACRO open ##### -->
+<!-- ##### MACRO write ##### -->
<para>
</para>
projects / platform / upstream / glib.git / blobdiff