[glibmm] Regenerate _docs.xml files.



commit 2d477f36407683b7e0d5e948939ef6ca4ffb7abf
Author: Murray Cumming <murrayc murrayc com>
Date:   Wed Feb 4 09:43:26 2015 +0100

    Regenerate _docs.xml files.

 gio/src/gio_docs.xml   |  423 ++++++++++++++++++++++++++++++++++++++++++++++++
 glib/src/glib_docs.xml |  216 +++++++++++++++++++++++--
 2 files changed, 626 insertions(+), 13 deletions(-)
---
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml
index ecb60fe..b8ea5b9 100644
--- a/gio/src/gio_docs.xml
+++ b/gio/src/gio_docs.xml
@@ -3939,6 +3939,36 @@ before calling the callback.
 </parameters>
 </enum>
 
+<signal name="GListModel::items-changed">
+<description>
+This signal is emitted whenever items were added or removed to
+ list  At @position, @removed items were removed and @added items
+were added in their place.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> the #GListModel that changed
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position at which @list changed
+</parameter_description>
+</parameter>
+<parameter name="removed">
+<parameter_description> the number of items removed
+</parameter_description>
+</parameter>
+<parameter name="added">
+<parameter_description> the number of items added
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
 <signal name="GMenuModel::items-changed">
 <description>
 Emitted when a change has occured to the menu.
@@ -44629,6 +44659,337 @@ trouble.
 </return>
 </function>
 
+<function name="g_list_model_get_item">
+<description>
+Get the item at @position. If @position is greater than the number of
+items in @list, %NULL is returned.
+
+%NULL is never returned for an index that is smaller than the length
+of the list.  See g_list_model_get_n_items().
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GListModel
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position of the item to fetch
+</parameter_description>
+</parameter>
+</parameters>
+<return> the item at @position.
+
+</return>
+</function>
+
+<function name="g_list_model_get_item_type">
+<description>
+Gets the type of the items in @list. All items returned from
+g_list_model_get_type() are of that type or a subtype, or are an
+implementation of that interface.
+
+The item type of a #GListModel can not change during the life of the
+model.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GListModel
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GType of the items contained in @list.
+
+</return>
+</function>
+
+<function name="g_list_model_get_n_items">
+<description>
+Gets the number of items in @list.
+
+Depending on the model implementation, calling this function may be
+less efficient than iterating the list with increasing values for
+ position until g_list_model_get_item() returns %NULL.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GListModel
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of items in @list.
+
+</return>
+</function>
+
+<function name="g_list_model_get_object">
+<description>
+Get the item at @position. If @position is greater than the number of
+items in @list, %NULL is returned.
+
+%NULL is never returned for an index that is smaller than the length
+of the list.  See g_list_model_get_n_items().
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GListModel
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position of the item to fetch
+</parameter_description>
+</parameter>
+</parameters>
+<return> the object at @position.
+
+</return>
+</function>
+
+<function name="g_list_model_items_changed">
+<description>
+Emits the #GListModel::items-changed signal on @list.
+
+This function should only be called by classes implementing
+#GListModel. It has to be called after the internal representation
+of @list has been updated, because handlers connected to this signal
+might query the new state of the list.
+
+Implementations must only make changes to the model (as visible to
+its consumer) in places that will not cause problems for that
+consumer.  For models that are driven directly by a write API (such
+as #GListStore), changes can be reported in response to uses of that
+API.  For models that represent remote data, changes should only be
+made from a fresh mainloop dispatch.  It is particularly not
+permitted to make changes in response to a call to the #GListModel
+consumer API.
+
+Stated another way: in general, it is assumed that code making a
+series of accesses to the model via the API, without returning to the
+mainloop, and without calling other code, will continue to view the
+same contents of the model.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GListModel
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position at which @list changed
+</parameter_description>
+</parameter>
+<parameter name="removed">
+<parameter_description> the number of items removed
+</parameter_description>
+</parameter>
+<parameter name="added">
+<parameter_description> the number of items added
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_list_store_append">
+<description>
+Appends @item to @store. @item must be of type #GListStore:item-type.
+
+This function takes a ref on @item.
+
+Use g_list_store_splice() to append multiple items at the same time
+efficiently.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="store">
+<parameter_description> a #GListStore
+</parameter_description>
+</parameter>
+<parameter name="item">
+<parameter_description> the new item
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_list_store_insert">
+<description>
+Inserts @item into @store at @position. @item must be of type
+#GListStore:item-type or derived from it. @position must be smaller
+than the length of the list, or equal to it to append.
+
+This function takes a ref on @item.
+
+Use g_list_store_splice() to insert multiple items at the same time
+efficiently.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="store">
+<parameter_description> a #GListStore
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position at which to insert the new item
+</parameter_description>
+</parameter>
+<parameter name="item">
+<parameter_description> the new item
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_list_store_insert_sorted">
+<description>
+Inserts @item into @store at a position to be determined by the
+ compare_func 
+
+The list must already be sorted before calling this function or the
+result is undefined.  Usually you would approach this by only ever
+inserting items by way of this function.
+
+This function takes a ref on @item.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="store">
+<parameter_description> a #GListStore
+</parameter_description>
+</parameter>
+<parameter name="item">
+<parameter_description> the new item
+</parameter_description>
+</parameter>
+</parameters>
+<return> the position at which @item was inserted
+
+</return>
+</function>
+
+<function name="g_list_store_new">
+<description>
+Creates a new #GListStore with items of type @item_type. @item_type
+must be a subclass of #GObject.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="item_type">
+<parameter_description> the #GType of items in the list
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GListStore
+</return>
+</function>
+
+<function name="g_list_store_remove">
+<description>
+Removes the item from @store that is at @position. @position must be
+smaller than the current length of the list.
+
+Use g_list_store_splice() to remove multiple items at the same time
+efficiently.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="store">
+<parameter_description> a #GListStore
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position of the item that is to be removed
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_list_store_remove_all">
+<description>
+Removes all items from @store.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="store">
+<parameter_description> a #GListStore
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_list_store_splice">
+<description>
+Changes @store by removing @n_removals items and adding @n_additions
+items to it. @additions must contain @n_additions items of type
+#GListStore:item-type.  %NULL is not permitted.
+
+This function is more efficient than g_list_store_insert() and
+g_list_store_remove(), because it only emits
+#GListModel::items-changed once for the change.
+
+This function takes a ref on each item in @additions.
+
+The parameters @position and @n_removals must be correct (ie:
+ position + @n_removals must be less than or equal to the length of
+the list at the time this function is called).
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="store">
+<parameter_description> a #GListStore
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position at which to make the change
+</parameter_description>
+</parameter>
+<parameter name="n_removals">
+<parameter_description> the number of items to remove
+</parameter_description>
+</parameter>
+<parameter name="additions">
+<parameter_description> the items to add
+</parameter_description>
+</parameter>
+<parameter name="n_additions">
+<parameter_description> the number of items to add
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="g_loadable_icon_load">
 <description>
 Loads a loadable icon. For the asynchronous version of this function, 
@@ -53328,6 +53689,24 @@ Since: 2.34
 </return>
 </function>
 
+<function name="g_settings_schema_key_get_name">
+<description>
+Gets the name of @key.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> a #GSettingsSchemaKey
+</parameter_description>
+</parameter>
+</parameters>
+<return> the name of @key.
+
+</return>
+</function>
+
 <function name="g_settings_schema_key_get_range">
 <description>
 Queries the range of a key.
@@ -53489,6 +53868,27 @@ Since: 2.40
 <return></return>
 </function>
 
+<function name="g_settings_schema_list_children">
+<description>
+Gets the list of children in @schema.
+
+You should free the return value with g_strfreev() when you are done
+with it.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="schema">
+<parameter_description> a #GSettingsSchema
+</parameter_description>
+</parameter>
+</parameters>
+<return> a list of the children on @settings
+
+</return>
+</function>
+
 <function name="g_settings_schema_ref">
 <description>
 Increase the reference count of @schema, returning a new reference.
@@ -54323,6 +54723,29 @@ Since: 2.30
 <return></return>
 </function>
 
+<function name="g_simple_action_set_state_hint">
+<description>
+Sets the state hint for the action.
+
+See g_action_get_state_hint() for more information about
+action state hints.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="simple">
+<parameter_description> a #GSimpleAction
+</parameter_description>
+</parameter>
+<parameter name="state_hint">
+<parameter_description> a #GVariant representing the state hint
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="g_simple_async_report_error_in_idle">
 <description>
 Reports an error in an asynchronous function in an idle function by
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index a08b996..543c939 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -3673,6 +3673,30 @@ Error codes returned by parsing text-format GVariants.
 </parameters>
 </enum>
 
+<enum name="GWin32OSType">
+<description>
+Type of Windows edition to check for at run-time.
+
+</description>
+<parameters>
+<parameter name="G_WIN32_OS_ANY">
+<parameter_description> The running system can be a workstation or a server edition of
+Windows.  The type of the running system is therefore not checked.
+</parameter_description>
+</parameter>
+<parameter name="G_WIN32_OS_WORKSTATION">
+<parameter_description> The running system is a workstation edition of Windows,
+such as Windows 7 Professional.
+</parameter_description>
+</parameter>
+<parameter name="G_WIN32_OS_SERVER">
+<parameter_description> The running system is a server edition of Windows, such as
+Windows Server 2008 R2.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
 <function name="g_access">
 <description>
 A wrapper for the POSIX access() function. This function is used to
@@ -4287,7 +4311,8 @@ This function generates enough precision that converting
 the string back using g_ascii_strtod() gives the same machine-number
 (on machines with IEEE compatible 64bit doubles). It is
 guaranteed that the size of the resulting string will never
-be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes.
+be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes, including the terminating
+nul character, which is always added.
 
 
 </description>
@@ -4316,6 +4341,8 @@ decimal point. To format the number you pass in
 a printf()-style format string. Allowed conversion
 specifiers are 'e', 'E', 'f', 'F', 'g' and 'G'.
 
+The returned buffer is guaranteed to be nul-terminated.
+
 If you just want to want to serialize the value into a
 string, use g_ascii_dtostr().
 
@@ -6304,6 +6331,130 @@ Since: 2.30
 </return>
 </function>
 
+<function name="g_auto">
+<description>
+Helper to declare a variable with automatic cleanup.
+
+The variable is cleaned up in a way appropriate to its type when the
+variable goes out of scope.  The type must support this.
+
+This feature is only supported on GCC and clang.  This macro is not
+defined on other compilers and should not be used in programs that
+are intended to be portable to those compilers.
+
+This is meant to be used with stack-allocated structures and
+non-pointer types.  For the (more commonly used) pointer version, see
+g_autoptr().
+
+This macro can be used to avoid having to do explicit cleanups of
+local variables when exiting functions.  It often vastly simplifies
+handling of error conditions, removing the need for various tricks
+such as 'goto out' or repeating of cleanup code.  It is also helpful
+for non-error cases.
+
+Consider the following example:
+
+|[
+GVariant *
+my_func(void)
+{
+g_auto(GQueue) queue = G_QUEUE_INIT;
+g_auto(GVariantBuilder) builder;
+
+g_variant_builder_init (&amp;builder, G_VARIANT_TYPE_VARDICT);
+
+...
+
+if (error_condition)
+return NULL;
+
+...
+
+return g_variant_builder_end (&amp;builder);
+}
+]|
+
+You must initialise the variable in some way -- either by use of an
+initialiser or by ensuring that an _init function will be called on
+it unconditionally before it goes out of scope.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="typename">
+<parameter_description> a supported variable type
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_autoptr">
+<description>
+Helper to declare a pointer variable with automatic cleanup.
+
+The variable is cleaned up in a way appropriate to its type when the
+variable goes out of scope.  The type must support this.
+
+This feature is only supported on GCC and clang.  This macro is not
+defined on other compilers and should not be used in programs that
+are intended to be portable to those compilers.
+
+This is meant to be used to declare pointers to types with cleanup
+functions.  The type of the variable is a pointer to @typename.  You
+must not add your own '*'.
+
+This macro can be used to avoid having to do explicit cleanups of
+local variables when exiting functions.  It often vastly simplifies
+handling of error conditions, removing the need for various tricks
+such as 'goto out' or repeating of cleanup code.  It is also helpful
+for non-error cases.
+
+Consider the following example:
+
+|[
+gboolean
+check_exists(GVariant *dict)
+{
+g_autoptr(GVariant) dirname;
+g_autoptr(GVariant) basename = NULL;
+g_autoptr(gchar) path = NULL;
+
+dirname = g_variant_lookup_value (dict, &quot;dirname&quot;, G_VARIANT_TYPE_STRING);
+
+if (dirname == NULL)
+return FALSE;
+
+basename = g_variant_lookup_value (dict, &quot;basename&quot;, G_VARIANT_TYPE_STRING);
+
+if (basename == NULL)
+return FALSE;
+
+path = g_build_filename (g_variant_get_string (dirname, NULL),
+g_variant_get_string (basename, NULL),
+NULL);
+
+return g_access (path, R_OK) == 0;
+}
+]|
+
+You must initialise the variable in some way -- either by use of an
+initialiser or by ensuring that it is assigned to unconditionally
+before it goes out of scope.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="typename">
+<parameter_description> a supported variable type
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="g_base64_decode">
 <description>
 Decode a sequence of Base-64 encoded text into binary data.  Note
@@ -28136,7 +28287,7 @@ by @newval, %FALSE otherwise.
 Releases all references to other objects. This can be used to break
 reference cycles.
 
-This functions should only be called from object system implementations.
+This function should only be called from object system implementations.
 
 </description>
 <parameters>
@@ -46076,7 +46227,7 @@ Since: 2.32
 
 <function name="g_thread_self">
 <description>
-This functions returns the #GThread corresponding to the
+This function returns the #GThread corresponding to the
 current thread. Note that this function does not increase
 the reference count of the returned struct.
 
@@ -57766,6 +57917,48 @@ Since: 2.32
 <return></return>
 </function>
 
+<function name="g_win32_check_windows_version">
+<description>
+Returns whether the version of the Windows operating system the
+code is running on is at least the specified major, minor and
+service pack versions.  See MSDN documentation for the Operating
+System Version.  Software that needs even more detailed version and
+feature information should use the Win32 API VerifyVersionInfo()
+directly.
+
+Successive calls of this function can be used for enabling or
+disabling features at run-time for a range of Windows versions,
+as per the VerifyVersionInfo() API documentation.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="major">
+<parameter_description> major version of Windows
+</parameter_description>
+</parameter>
+<parameter name="minor">
+<parameter_description> minor version of Windows
+</parameter_description>
+</parameter>
+<parameter name="spver">
+<parameter_description> Windows Service Pack Level, 0 if none
+</parameter_description>
+</parameter>
+<parameter name="os_type">
+<parameter_description> Type of Windows OS
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the Windows Version is the same or greater than
+the specified major, minor and service pack versions, and
+whether the running Windows is a workstation or server edition
+of Windows, if specifically specified.
+
+</return>
+</function>
+
 <function name="g_win32_error_message">
 <description>
 Translate a Win32 error code (as returned by GetLastError() or
@@ -57976,17 +58169,14 @@ freed with g_free() when no longer needed. If something goes wrong,
 
 <function name="g_win32_get_windows_version">
 <description>
-Returns version information for the Windows operating system the
-code is running on. See MSDN documentation for the GetVersion()
-function. To summarize, the most significant bit is one on Win9x,
-and zero on NT-based systems. Since version 2.14, GLib works only
-on NT-based systems, so checking whether your are running on Win9x
-in your own software is moot. The least significant byte is 4 on
-Windows NT 4, and 5 on Windows XP. Software that needs really
-detailed version and feature information should use Win32 API like
-GetVersionEx() and VerifyVersionInfo().
+This function is deprecated. Use
+g_win32_check_windows_version() instead.
 
-Since: 2.6
+Deprecated: 2.44: Be aware that for Windows 8.1 and Windows Server
+2012 R2 and later, this will return 62 unless the application is
+manifested for Windows 8.1/Windows Server 2012 R2, for example.
+MSDN stated that GetVersion(), which is used here, is subject to
+further change or removal after Windows 8.1.
 
 </description>
 <parameters>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]